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

文档中心

导航

DescribeNLBListeners

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

调用 DescribeNLBListeners 接口，查询满足指定条件的监听器。

请求参数

下表中非必选参数均未传入时，返回当前账号下的所有监听器。

名称	类型	是否必选	示例值	说明
Action	String	是	DescribeNLBListeners	要执行的操作，取值为DescribeNLBListeners。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
LoadBalancerId	String	否	nlb-bp1o94dp5i6ea****	NLB实例ID。您可以调用DescribeNetworkLoadBalancers接口获取NLB实例ID。
ListenerIds.N	String	否	ListenerIds.1=lsn-2fek3rgsxhrsw5oxr** &ListenerIds.2=lsn-2fel9ycnzz94w5ox**	监听器的ID。 N：表示监听器的序号，取值范围为1 ～ 100。多个监听器ID之间用&分隔。
ListenerName	String	否	mylistener	监听器的名称。
MaxResult	Integer	否	10	分页查询时每页的行数，取值范围为1 ~ 20，默认值为10。
NextToken	string	否	caeba0bbb2be03f84eb48b699f0a****	分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的`NextToken`参数值。
Tags.N.Key	String	否	Tags.1.Key=k1&Tags.2.Key=k2	用户标签的标签键。 N：表示标签信息的序号，需按照数字顺序从1开始填写，取值范围 1～20。多个标签键之间使用&分隔。长度限制为1～128个字符。大小写敏感，不能以`volc:`或`sys:`的任意大小写组合开头。不能以空格开头或结尾。允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。说明同一资源的标签键不允许重复。
Tags.N.Value	String	否	Tags.1.Value=v1&Tags.2.Value=v2	用户标签的标签值。 N：表示标签信息的序号，需按照数字顺序从1开始填写，取值范围 1～20。多个标签值之间使用&分隔。每个标签键对应一个标签值。长度限制为0～255个字符。大小写敏感，不能以空格开头或结尾。允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。说明如果传入该参数，则必须先传入`Tags.N.Key`。

返回参数

名称	类型	示例值	描述
RequestId	String	2024092952539010225146063030****	请求ID。
NextToken	String	caeba0bbb2be03f84eb48b699f0a****	本次调用返回的查询凭证值，返回为空表示没有下一页。
Listeners	Array of Struct	--	符合条件的监听器的详细信息。具体请参见下表“ Listeners ”。

Listeners

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

请求示例

GET /?Action=DescribeNLBListeners&Version=2020-04-01&LoadBalancerId=nlb-bp1o94dp5i6ea****&ListenerIds.1=lsn-1g1byzqnu5s748ibuxyfo****&ListenerIds.2=lsn-2fe5agi01myo059gp68d4**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-guangzhou
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024092952539010225146063030****",
        "Action": "DescribeNLBListeners",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-guangzhou"
    },  
    "Result": {
        "RequestId": "2024092952539010225146063030****",
        "NextToken": "",
        "Listeners": [
            {
                "CreateTime": "2024-09-25T07:58:48Z",
                "UpdateTime": "2024-09-26T07:22:11Z",
                "ListenerId": "lsn-1g1byzqnu5s748ibuxyfo****",
                "AccountId": "210005****",
                "ListenerName": "TCP-80",
                "Status": "Disabled",
                "Description": "",
                "Protocol": "TCP",
                "Port": 80,
                "Enabled": false,
                "ConnectionTimeout": 900,
                "LoadBalancerId": "nlb-bp1o94dp5i6ea****",
                "ServerGroupId": "rsp-2fe5afmf9uhog59gp680g****",
                "Tags": []
            },
            {
                "CreateTime": "2024-09-25T06:44:16Z",
                "UpdateTime": "2024-09-25T06:44:29Z",
                "ListenerId": "lsn-2fe5agi01myo059gp68d4****",
                "AccountId": "210005****",
                "ListenerName": "UDP-8080",
                "Status": "Active",
                "Description": "",
                "Protocol": "UDP",
                "Port": 80,
                "Enabled": true,
                "ConnectionTimeout": 900,
                "LoadBalancerId": "nlb-bp1o94dp5i6ea****",
                "ServerGroupId": "rsp-2fe5afscd6nls59gp67fk****",
                "Tags": []
            }
        ]
    }
}

错误码

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