获取监听器下后端服务器的列表--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取监听器下后端服务器的列表

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

本接口用于获取监听器下后端服务器的列表。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	ListListenerEndpoints	公共参数。该参数表示接口名称。取值：ListListenerEndpoints
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
lb_identity	String	是	veew-lb2131011027612112****	负载均衡实例的 ID。您可以通过 ListLBs 接口查询负载均衡实例的 ID。
listen_port	Integer	是	80	监听端口。
listen_port_protocol	String	是	TCP	监听协议。取值范围： TCP UDP
endpoint_identity	String	否	veen1128038002028123****	后端服务器的 ID。
endpoint_ip	String	否	127...1	后端服务器的 IP 地址。
page	Integer	否	1	后端服务器列表的页码。
limit	Integer	否	10	分页查询时设置的每页行数。
order_by	Integer	否	1	查询出来的后端服务器的排列顺序，按照创建时间排序。取值范围： 1（默认值）：按照降序排列。 2：按照升序排列。

返回参数

参数	类型	示例值	描述
endpoint_list	[]Endpoint	请参见返回示例	后端服务器的列表。
total_count	Integer	1	后端服务器的数量。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230531161509719CAE51155182AB****",
        "Action": "ListListenerEndpoints",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "endpoint_list": [
            {
                "endpoint_identity": "veen3232700340212300****",
                "endpoint_name": "",
                "endpoint_type": "veen",
                "port": 80,
                "weight": 0,
                "internal_ips": [
                    {
                        "ip_addr": "172.**.**.80",
                        "ip_version": "ipv4",
                        "isp": "",
                        "primary": true
                    }
                ],
                "external_ips": [
                    {
                        "ip_addr": "115.**.**.22",
                        "ip_version": "ipv4",
                        "isp": "CTCC",
                        "primary": false
                    }
                ],
                "mac_addr": "0a:58:ac:**:**:50",
                "healthy_status": true,
                "endpoint_uniq": "7540b5312d95176f4a59e201af07****"
            },
            {
                "endpoint_identity": "veen1580202322281535****",
                "endpoint_name": "",
                "endpoint_type": "veen",
                "port": 80,
                "weight": 0,
                "internal_ips": [
                    {
                        "ip_addr": "172.**.**.82",
                        "ip_version": "ipv4",
                        "isp": "",
                        "primary": true
                    }
                ],
                "external_ips": [
                    {
                        "ip_addr": "115.**.**.23",
                        "ip_version": "ipv4",
                        "isp": "CTCC",
                        "primary": false
                    }
                ],
                "mac_addr": "0a:58:ac:**:**:52",
                "healthy_status": true,
                "endpoint_uniq": "212373e4d72fd3ba25c32971f843****"
            }
        ],
        "total_count": 2
    }
}

错误码

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