获取负载均衡实例列表--边缘计算节点-火山引擎

文档中心

立即注册

导航

获取负载均衡实例列表

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

本接口用于获取负载均衡实例的列表。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	ListLBs	公共参数。该参数表示接口名称。取值：ListLBs。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
page	Integer	否	1	负载均衡实例的列表的页码。
limit	Integer	否	10	分页查询时设置的每页行数。
order_by	Integer	否	1	查询出来的负载均衡实例的排列顺序，按照创建时间排序。取值范围： 1（默认值）：按照降序排列。 2：按照升序排列。
name	String	否	lb-test	负载均衡实例的名称。支持模糊查询。
lb_identities	String	否	veew-lb2131011027612112****	负载均衡实例的 ID 的列表。ID 之间用半角逗号（,）分隔。
region	String	否	EastChina	负载均衡实例所在大区。
ip	String	否	123...158	负载均衡实例绑定的弹性公网 IP 地址。
vpc_name	String	否	郑州联通01	负载均衡实例所属的私有网络的名称。支持模糊查询。
vpc_identities	String	否	vpc-sbjngs****	负载均衡实例所属私有网络的 ID 的列表。ID 之间用半角逗号（,）分隔。
cluster_name	String	否	****-zzcu01	负载均衡实例所在的节点的名称。

返回参数

参数	类型	示例值	描述
lb_list	[]LB	请参见返回示例	负载均衡实例的列表。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230609164730ED8E9A8897F87B12****",
        "Action": "ListLBs",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "lb_list": [
            {
                "identity": "veew-lb12223330222024232****",
                "name": "test-3",
                "region": "EastChina",
                "city": "321000",
                "cluster_name": "**cm02",
                "cluster_alias": "**移动02",
                "vpc_name": "**移动02-默认VPC",
                "vpc_identity": "vpc-8qnfxg****",
                "vpc_subnets": [
                    "172.**.**.64/26"
                ],
                "status": "bound",
                "ips": [
                    {
                        "ipIdentity": "eip-7gf4l9****",
                        "ip": "36.**.**.40",
                        "ip_name": "",
                        "ip_type": "IPv4",
                        "bandwidth_peak": "20",
                        "ack": true,
                        "color": ""
                    },
                    {
                        "ipIdentity": "eip-p8j2f6****",
                        "ip": "36.**.**.39",
                        "ip_name": "",
                        "ip_type": "IPv4",
                        "bandwidth_peak": "20",
                        "ack": true,
                        "color": ""
                    }
                ],
                "listeners": [
                    {
                        "name": "listerner-0",
                        "listen_port_protocol": "TCP",
                        "listen_port": 80,
                        "loadbalance_strategy": "sip+sport",
                        "desc": "",
                        "endpoints": [],
                        "listener_uniq": "a46c0c0ed2c38bc514528db2515f****",
                        "default_endpoint_port": 80
                    },
                    {
                        "name": "listerner-2",
                        "listen_port_protocol": "TCP",
                        "listen_port": 90,
                        "loadbalance_strategy": "sip+sport",
                        "desc": "",
                        "endpoints": [],
                        "listener_uniq": "d85ba2a1b9c3f54ab853577f8aeb****",
                        "default_endpoint_port": 90
                    }
                ],
                "desc": "",
                "billing_method": "MonthlyPeak",
                "create_time": 1646195750,
                "update_time": 1652342012,
                "lb_type": "IPv4",
                "account_identity": 210006****,
                "rs_type": "veen",
                "clusters": [
                    {
                        "cluster_name": "**cm02",
                        "alias": "**移动02",
                        "country": "CN",
                        "region": "EastChina",
                        "province": "JS",
                        "city": "321000",
                        "isp": "CMCC"
                    }
                ],
                "isp": "CMCC",
                "eip_num": 1,
                "is_bare_metal": false,
                "forward_mode": ""
            }
        ]
    }
}

错误码

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