DescribeNLBListenerAttributes--负载均衡-火山引擎

文档中心

导航

DescribeNLBListenerAttributes

最近更新时间：2024.12.04 17:10:14首次发布时间：2024.12.04 17:10:14

调用 DescribeNLBListenerAttributes 接口，查询指定监听器的详细信息。

请求参数

名称	类型	是否必选	示例值	说明
Action	String	是	DescribeNLBListenerAttributes	要执行的操作，取值为DescribeNLBListenerAttributes。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
ListenerId	String	是	lsn-2fek3rgsxhrsw5oxruwec****	监听器的ID。您可以调用DescribeNLBListeners接口获取监听器ID。

返回参数

名称	类型	示例值	描述
RequestId	String	2024092952539010225146063030****	请求ID。
LoadBalancerId	String	nlb-bp1o94dp5i6ea****	监听器所属的NLB实例ID。
ListenerId	String	lsn-2fek3rgsxhrsw5oxruwec****	监听器的ID。
ProjectName	String	default	监听器所属的项目名称。
ListenerName	String	mylistener	监听器的名称。
Description	String	test	监听器的描述。
ConnectionTimeout	String	90	监听器的连接超时时间。
Protocol	String	TCP	监听器的协议。
Port	Integer	80	监听器接收请求使用的端口。 0表示启用全端口监听。
StartPort	Integer	80	全端口监听的起始端口。仅参数`Port`为0时，返回该参数。
EndPort	Integer	100	全端口监听的结束端口。仅参数`Port`为0时，返回该参数。
ServerGroupId	String	rsp-bp1o94dp5i6ea****	监听器关联的服务器组ID。
Status	String	Active	监听器的状态。 Creating：创建中。 Active：运行中。 Deleting: 删除中。 Disabled: 已停用。
Enabled	String	off	是否启用监听器。 on：开启。 off：关闭。
CreateTime	String	2024-08-11T16:37:37Z	监听器的创建时间。
UpdateTime	String	2024-08-11T16:37:37Z	监听器的最近操作时间。

请求示例

GET /?Action=DescribeNLBListenerAttributes&Version=2020-04-01&ListenerId=lsn-2fek3rgsxhrsw5oxruwec**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-guangzhou
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024092952539010225146063030****",
        "Action": "DescribeNLBListenerAttributes",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-guangzhou"
    },     
     "Result": {
        "RequestId": "2024092952539010225146063030****",
        "CreateTime": "2024-09-25T06:44:16Z",
        "UpdateTime": "2024-09-25T06:44:29Z",
        "ListenerId": "lsn-2fe5agi01myo059gp68d4****",
        "AccountId": "210005****",
        "ListenerName": "TCP-80",
        "Status": "Active",
        "Description": "",
        "Protocol": "TCP",
        "Port": 80,
        "Enabled": true,
        "ConnectionTimeout": 900,
        "LoadBalancerId": "nlb-2fe5af0pxlvy859gp68ag****",
        "ServerGroupId": "rsp-2fe5afscd6nls59gp67fk****",
        "Tags": []
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。