查询负载均衡器

功能介绍

查询负载均衡器列表。支持过滤查询和分页查询。如未特殊说明，匹配规则为精确匹配。

接口约束

分页查询使用的参数为marker、limit、page_reverse。marker和page_reverse只有和limit一起使用时才会生效，单独使用无效。

URI

GET /v2.0/lbaas/loadbalancers

请求消息

表1 请求参数
参数	是否必选	参数类型	描述
marker	否	String	分页查询的起始的资源ID，表示上一页最后一条查询记录的负载均衡器的ID。必须与limit一起使用。
limit	否	Integer	分页查询每页的负载均衡器个数。
page_reverse	否	Boolean	分页的顺序，true表示从后往前分页，false表示从前往后分页，默认为false。必须与limit一起使用。
tenant_id	否	String	负载均衡器所在项目的ID。
project_id	否	String	此参数和tenant_id参数含义一样，均指负载均衡器所在的项目ID。
id	否	String	负载均衡器的ID。
description	否	String	负载均衡器的描述信息。支持的最大字符长度：255
name	否	String	负载均衡器的名称。支持的最大字符长度：255
operating_status	否	String	负载均衡器的操作状态。取值范围：可以为ONLINE和FROZEN。
provisioning_status	否	String	该字段为预留字段，暂未启用。负载均衡器的配置状态。取值范围：可以为ACTIVE。
admin_state_up	否	Boolean	负载均衡器的管理状态。该字段为预留字段，暂未启用。默认为true。
vip_address	否	String	负载均衡器的内网IP。支持的最大字符长度：64
vip_port_id	否	String	负载均衡器内网IP对应的端口ID。
vip_subnet_id	否	String	负载均衡器所在的子网IPv4子网ID。
member_address	否	String	负载均衡器的后端服务器的IP地址。
member_device_id	否	String	负载均衡器的后端服务器对应的弹性云服务器ID。
vpc_id	否	String	负载均衡器所在的虚拟私有云ID。

响应消息

表2 响应参数
参数	参数类型	描述
loadbalancers	Array	负载均衡器对象列表。详见表3。
loadbalancers_links	Array	负载均衡器的分页查询中上下页的链接信息。仅当分页查询时响应体中有该字段。详见表表6 loadbalancers_links字段说明字段说明

表3 loadbalancer字段说明
参数	是否必选	参数类型	描述
name	否	String	负载均衡器名称。支持的最大字符长度：255
description	否	String	负载均衡器的描述信息。支持的最大字符长度：255
tenant_id	否	String	负载均衡器所在的项目ID。支持的最大字符长度：255 需要和token中的project_id一致。
project_id	否	String	此参数和tenant_id参数含义一样，均指负载均衡器所在的项目ID。需要和token中的project_id一致。
vip_subnet_id	是	String	负载均衡器所在的子网IPv4子网ID。可通过查询子网列表接口GET {vpc的endpoint}/v2.0/subnets获取。 vip_address将从该子网中产生。只支持指定IPv4的子网ID。暂不支持IPv6。
provider	否	String	负载均衡器的生产者。取值范围：vlb。
vip_address	否	String	负载均衡器的内网IP。该IP必须为vip_subnet_id字段指定的子网网段中的IP。若不指定，自动从vip_subnet_id字段指定的子网网段中生成一个IP地址。支持的最大字符长度：64
admin_state_up	否	Boolean	负载均衡器的管理状态。该字段为预留字段，暂未启用。默认为true。

表4 listeners字段说明
参数	参数类型	描述
id	String	关联的监听器id

表5 pools字段说明
参数	参数类型	描述
id	String	关联的后端服务器组id

表6 loadbalancers_links字段说明
参数	参数类型	描述
href	String	负载均衡器的分页查询中上下页的链接。
rel	String	上下页的提示信息。取值范围：next、previous。next表示href是下一页的url，previous表示href是上一页的url。

请求示例

请求样例1 全量查询负载均衡器

GET https://{Endpoint}/v2.0/lbaas/loadbalancers

请求样例2 分页查询负载均衡器，每页1个负载均衡器，起始负载均衡器的ID为165b6a38-5278-4569-b747-b2ee65ea84a4，则查出的负载均衡器为165b6a38-5278-4569-b747-b2ee65ea84a4的下一个。
```
GET https://{Endpoint}/v2.0/lbaas/loadbalancers?limit=1&marker=165b6a38-5278-4569-b747-b2ee65ea84a4
```
请求样例3 过滤查询与IP为192.168.0.191的后端云服务器关联的负载均衡器
```
GET https://{Endpoint}/v2.0/lbaas/loadbalancers?member_address=192.168.0.181
```

响应示例

响应样例1

{
    "loadbalancers": [
        {
            "description": "simple lb",
            "admin_state_up": true,
            "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c",
            "project_id": "1a3e005cf9ce40308c900bcb08e5320c",
            "provisioning_status": "ACTIVE",
            "vip_subnet_id": "5328f1e6-ce29-44f1-9493-b128a5653350",
            "listeners": [
                {
                    "id": "45196943-2907-4369-87b1-c009b1d7ac35"
                }
            ],
            "vip_address": "10.0.0.2",
            "vip_port_id": "cbced4fe-6f6f-4fd6-9348-0c3d1219d6ca",
            "provider": "vlb",
            "pools": [
                {
                    "id": "21d49cf7-4fd3-4cb6-8c48-b7fc6c259aab"
            }
            ],
            "id": "a9729389-6147-41a3-ab22-a24aed8692b2",
            "operating_status": "ONLINE",
            "tags": [],
            "name": "loadbalancer1",
            "created_at": "2018-07-25T01:54:13", 
            "updated_at": "2018-07-25T01:54:14"
        }
    ]
}

响应样例2

{
    "loadbalancers": [
        {
            "description": "",
            "provisioning_status": "ACTIVE",
            "tenant_id": "601240b9c5c94059b63d484c92cfe308",
            "project_id": "601240b9c5c94059b63d484c92cfe308",
            "admin_state_up": true,
            "provider": "vlb",
            "pools": [
                {
                    "id": "b13dba4c-a44c-4c40-8f6e-ce7a162b9f22"
                },
                {
                    "id": "4b9e765f-82ee-4128-911b-0a2d9ebc74c7"
                }
            ],
            "listeners": [
                {
                    "id": "21c41336-d0d3-4349-8641-6e82b4a4d097"
                }
            ],
            "vip_port_id": "44ac5d9b-b0c0-4810-9a9d-c4dbf541e47e",
            "operating_status": "ONLINE",
            "vip_address": "192.168.0.234",
            "vip_subnet_id": "9d60827e-0e5c-490a-8183-0b6ebf9084ca",
            "id": "e79a7dd6-3a38-429a-95f9-c7f78b346cbe",
            "tags": [],
            "name": "elb-robot",
            "created_at": "2018-07-25T01:54:13", 
            "updated_at": "2018-07-25T01:54:14"
        }
    ],
    "loadbalancers_links": [
        {
            "href": "https://network.Region.dc1.domainname.com/v2.0/lbaas/loadbalancers?limit=10&marker=e79a7dd6-3a38-429a-95f9-c7f78b346cbe&page_reverse=True",
              "rel": "previous"
        }
    ]
}

响应样例3

{
    "loadbalancers": [
        {
            "description": "",
            "provisioning_status": "ACTIVE",
            "tenant_id": "601240b9c5c94059b63d484c92cfe308",
            "project_id": "601240b9c5c94059b63d484c92cfe308",
            "created_at": "2018-11-29T13:55:20",
            "admin_state_up": true,
            "update_at": "2018-11-29T13:55:21",
            "id": "c1127125-64a9-4394-a08a-ef3be8f7ef9c",
            "pools": [
                {
                    "id": "2f6895be-019b-4c82-9b53-c4a2ac009e20"
                }
            ],
            "listeners": [
                {
                    "id": "5c63d176-444f-4c75-9cfe-bcb8a05a845c"
                }
            ],
            "vip_port_id": "434ac600-b779-4428-b7a7-830e047511f1",
            "operating_status": "ONLINE",
            "vip_address": "192.168.0.181",
            "vip_subnet_id": "9a303536-417c-45dc-a6db-1234b9e1c2b2",
            "provider": "vlb",
            "tags": [],
            "name": "elb-ftci"

        }
    ]
}

返回码

请参见状态码。

父主题：负载均衡器

上一篇：创建负载均衡器

下一篇：查询负载均衡详情

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消