获取监听器列表--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取监听器列表

最近更新时间：2024.07.02 15:51:17首次发布时间：2022.02.25 18:58:31

本接口用于获取负载均衡实例关联的监听器的列表。

请求说明

请求方式：GET
请求地址：https://veenedge.volcengineapi.com?Action=ListLBListeners&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	ListLBListeners	公共参数。该参数表示接口名称。取值：ListLBListeners
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
lb_identity	String	是	veew-lb2131011027612112****	负载均衡实例的 ID。您可以通过 ListLBs 接口查询负载均衡实例的 ID。
listener_name	String	否	listener-1	监听器的名称。
page	Integer	否	1	监听器的列表的页码。
limit	Integer	否	10	分页查询时设置的每页行数。
order_by	Integer	否	1	查询出来的监听器的排列顺序，按照创建时间排序。取值范围： 1（默认值）：按照降序排列。 2：按照升序排列。

返回参数

参数	类型	示例值	描述
listener_list	[]Listener	请参见返回示例	监听器列表。
total_count	Integer	1	监听器的数量。

请求示例

GET https://veenedge.volcengineapi.com/?Action=ListLBListeners&Version=2021-04-30
&lb_identity=veew-lb1047700072022322****
&<其他公共参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230531151249CCC7807707AA5CDF****",
        "Action": "ListLBListeners",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "listener_list": [
            {
                "name": "listener-1",
                "listen_port_protocol": "TCP",
                "listen_port": 81,
                "loadbalance_strategy": "sip",
                "desc": "",
                "endpoints": [
                    {
                        "endpoint_identity": "veen1580202322281535****",
                        "endpoint_name": "",
                        "endpoint_type": "",
                        "port": 80,
                        "weight": 0,
                        "internal_ips": [],
                        "external_ips": [],
                        "mac_addr": "",
                        "healthy_status": false,
                        "endpoint_uniq": "",
                        "enabled": true
                    }
                ],
                "create_time": 1685516408,
                "listener_uniq": "f717854c8e4cd6593b81f6461dbd****",
                "default_endpoint_port": 81
            },
            {
                "name": "listener-2",
                "listen_port_protocol": "TCP",
                "listen_port": 80,
                "loadbalance_strategy": "sip+sport",
                "desc": "",
                "endpoints": [
                    {
                        "endpoint_identity": "veen3232700340212300****",
                        "endpoint_name": "",
                        "endpoint_type": "",
                        "port": 80,
                        "weight": 0,
                        "internal_ips": [],
                        "external_ips": [],
                        "mac_addr": "",
                        "healthy_status": false,
                        "endpoint_uniq": "",
                        "enabled": true
                    }
                ],
                "health_check": {
                    "protocol": "TCP",
                    "port": 80,
                    "timeout": 3,
                    "period": 5,
                    "failure_threshold": 3,
                    "success_threshold": 3,
                    "http_host": "",
                    "http_path": "",
                    "http_success_codes": "",
                    "udp_check_string": "",
                    "use_endpoint_port": true
                },
                "create_time": 1682415025,
                "listener_uniq": "bd3f09f075b6af208afccca934fe****",
                "default_endpoint_port": 80
            }
        ],
        "total_count": 2
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。