# 查询负载均衡列表 - ListLoadBalancers #### 功能介绍 查询负载均衡器。支持过滤查询和分页查询。具体分页查询操作请参考[如何分页查询](https://support.huaweicloud.com/api-elb/elb_qs_0014.html)。 如未特殊说明，匹配规则为精确匹配。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=ELB&api=ListLoadbalancers&version=v2)中直接运行调试该接口。 #### URI GET /v2/{project_id}/elb/loadbalancers 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 操作用户的项目ID。 获取方法详见[获取项目ID](https://support.huaweicloud.com/api-elb/elb_fl_0008.html)。 | 表2查询参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | marker | 否 | String | 分页查询的起始的资源ID，表示上一页最后一条查询记录的负载均衡器的ID。 必须与limit一起使用。 | | limit | 否 | Integer | 分页查询每页的负载均衡器个数。如果不设置，则默认不分页查询所有。 | | page_reverse | 否 | Boolean | 分页的顺序，true表示从后往前分页，false表示从前往后分页，默认为false。 必须与limit一起使用。 | | id | 否 | String | 负载均衡器的ID。 | | description | 否 | String | 负载均衡器的描述信息。 支持的最大字符长度：255 | | name | 否 | String | 负载均衡器的名称。 支持的最大字符长度：255 | | operating_status | 否 | String | 负载均衡器的操作状态。 取值范围： ONLINE：正常运行。 FROZEN：已冻结。 | | provisioning_status | 否 | String | 该字段为预留字段，暂未启用。 负载均衡器的配置状态。取值范围：可以为ACTIVE。 | | admin_state_up | 否 | Boolean | 负载均衡器的管理状态。负载均衡器停用时不再接收流量。 取值范围： true：启用负载均衡器。 false：停用负载均衡器。 | | 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。 | | enterprise_project_id | 否 | String | 企业项目ID。 - 如果enterprise_project_id不传值，默认查询所有企业项目下的资源，鉴权按照细粒度权限鉴权，必须在用户组下分配elb:\*list权限。 - 如果enterprise_project_id传值，分为传具体eps_id和all_granted_eps两种场景，前者查询指定eps_id的eps下的资源，后者查询的是所有有list权限的eps下的资源。 | #### 请求消息 无 #### 响应消息 表3响应参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | loadbalancers | Array of [Loadbalancers] objects | 负载均衡器对象列表。详见[表4]。 | 表4loadbalancer字段说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 负载均衡器ID。 | | project_id | String | 负载均衡器所在项目的ID。 | | tenant_id | String | 租户ID。 | | name | String | 负载均衡器名称。 支持的最大字符长度：255 | | description | String | 负载均衡器的描述信息。 支持的最大字符长度：255 | | vip_subnet_id | String | 负载均衡器所在的子网IPv4子网ID。 | | vip_port_id | String | 负载均衡器内网IP对应的端口ID。 | | provider | String | 负载均衡器的生产者名称。 | | vip_address | String | 负载均衡器的内网IP。 支持的最大字符长度：64 | | listeners | Array of [Listeners](https://support.huaweicloud.com/api-elb/elb_qy_fz_0001.html#elb_qy_fz_0001__table107875111574) objects | 负载均衡器关联监听器ID的列表。详见[表7](https://support.huaweicloud.com/api-elb/elb_qy_fz_0001.html#elb_qy_fz_0001__table107875111574) | | pools | Array of [Pools](https://support.huaweicloud.com/api-elb/elb_qy_fz_0001.html#elb_qy_fz_0001__table1566642411246) objects | 负载均衡器关联后端服务器组ID的列表。详见[表8](https://support.huaweicloud.com/api-elb/elb_qy_fz_0001.html#elb_qy_fz_0001__table1566642411246) | | operating_status | String | 负载均衡器的操作状态。 取值范围： ONLINE：正常运行。 FROZEN：已冻结。 | | provisioning_status | String | 该字段为预留字段，暂未启用。 负载均衡器的配置状态。取值范围：可以为ACTIVE。 | | admin_state_up | Boolean | 负载均衡器的管理状态。负载均衡器停用时不再接收流量。 取值范围： true：启用负载均衡器。 false：停用负载均衡器。 | | tags | Array | 负载均衡器的标签列表。 | | created_at | String | 负载均衡器的创建时间。 格式为UTC时间：YYYY-MM-DDTHH:MM:SS 支持的最大字符长度：19 | | updated_at | String | 负载均衡器的更新时间。 格式为UTC时间：YYYY-MM-DDTHH:MM:SS 支持的最大字符长度：19 | | enterprise_project_id | String | 企业项目ID。创建负载均衡器时，给负载均衡器绑定企业项目ID。 取值范围：带"-"连字符的UUID格式，或者是字符串"0"。"0"表示默认企业项目。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见[《企业管理用户指南》](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0126101490.html)。 | | charge_mode | String | 计费模式。取值： - flavor，表示性能保障模式，提供并发连接数50,000、每秒连接数5,000、每秒查询数5,000的保障能力，规格范围内可提供性能保障，超出部分不提供性能保障。该模式会收取费用。 - null，表示非性能保障，不提供性能保障。 | | billing_info | String | 资源账单信息。取值： - 空：按需计费。 - 非空：包周期计费。 格式为： order_id:product_id:region_id:project_id，如： CS2107161019CDJZZ:OFFI569702121789763584:region1: 057ef081eb00d2732fd1c01a9be75e6f | | frozen_scene | String | 负载均衡器的冻结场景。若负载均衡器有多个冻结场景，用逗号分隔。取值： - POLICE：公安冻结场景。 - ILLEGAL：违规冻结场景。 - VERIFY：客户未实名认证冻结场景。 - PARTNER：合作伙伴冻结（合作伙伴冻结子客户资源）。 - AREAR：欠费冻结场景。 | | protection_status | String | 当前资源保护状态, 取值： - nonProtection: 不保护，默认值为nonProtection - consoleProtection: 控制台修改保护 | | protection_reason | String | 资源保护的原因。仅当protection_status为consoleProtection时有效。 | | publicips | Array of [PublicIpInfo](https://support.huaweicloud.com/api-elb/elb_qy_fz_0001.html#elb_qy_fz_0001__response_PublicIpInfo) objects | 负载均衡器绑定的公网IP。只支持绑定一个公网IP。 | 表5listeners字段说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 关联的监听器id | 表6pools字段说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 关联的后端服务器组id | #### 请求示例 - 请求样例1 ``` GET https://{Endpoint}/v2/1a3e005cf9ce40308c900bcb08e5320c/elb/loadbalancers ``` - 请求样例2 ``` GET https://{Endpoint}/v2/1a3e005cf9ce40308c900bcb08e5320c/elb/loadbalancers?limit=10&marker=165b6a38-5278-4569-b747-b2ee65ea84a4 ``` - 请求样例3 ``` GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/loadbalancers?vip_address=192.168.0.16 ``` #### 响应示例 - 响应样例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", "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" } ] } ``` - 响应样例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", "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" } ] } ``` - 响应样例3 ``` { "loadbalancers": [ { "description": "", "provisioning_status": "ACTIVE", "tenant_id": "601240b9c5c94059b63d484c92cfe308", "project_id": "601240b9c5c94059b63d484c92cfe308", "admin_state_up": true, "provider": "vlb", "pools": [ { "id": "ed75f16e-fcc6-403e-a3fb-4eae82005eab" }, { "id": "f15f2723-4135-4bf8-9259-047d92684197" } ], "listeners": [ { "id": "75045172-70e9-480d-9443-b8b6459948f7" }, { "id": "b9a99cbb-d0a1-4269-bc5f-752ec37a10c3" } ], "vip_port_id": "fb3f10f0-9417-4cf2-a82e-8f1da1687484", "operating_status": "ONLINE", "vip_address": "192.168.0.16", "vip_subnet_id": "3a450aa4-f642-4da8-b70d-cafd4a633b51", "id": "bc7ba445-035a-4464-a1a3-a62cf4a14116", "tags": [], "name": "elb-hm-test", "created_at": "2018-07-25T01:54:13", "updated_at": "2018-07-25T01:54:14", "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" } ] } ``` #### 返回码 请参见[状态码](https://support.huaweicloud.com/api-elb/elb_gc_1102.html)。