调试
您可以在API Explorer中直接运行调试该接口。
URI
GET /v2/{project_id}/elb/loadbalancers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
操作用户的项目ID。 获取方法详见获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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。 |
|
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。 |
|
ent erp rise_project_id |
否 |
String |
企业项目ID。
|
请求消息
无
响应消息
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
负载均衡器ID。 |
|
project_id |
String |
负载均衡器所在项目的ID。 |
|
tenant_id |
String |
负载均衡器所在项目的ID。 支持的最大字符长度：255 |
|
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 objects |
负载均衡器关联监听器ID的列表。详见表6 |
|
pools |
Array of Pools objects |
负载均衡器关联后端服务器组ID的列表。详见表7 |
|
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的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
关联的监听器id |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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?member_address=192.168.0.198
响应示例
- 响应样例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" } ] }
返回码
请参见状态码。
