功能介紹
查詢 負(fù)載均衡 器。支持過(guò)濾查詢和分頁(yè)查詢。具體分頁(yè)查詢操作請(qǐng)參考如何分頁(yè)查詢。
如未特殊說(shuō)明，匹配規(guī)則為精確匹配。
調(diào)試
您可以在API Explorer中直接運(yùn)行調(diào)試該接口。
URI
GET /v2/{project_id}/elb/loadbalancers
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
操作用戶的項(xiàng)目ID。 獲取方法詳見獲取項(xiàng)目ID。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
marker |
否 |
String |
分頁(yè)查詢的起始的資源ID，表示上一頁(yè)最后一條查詢記錄的負(fù)載均衡器的ID。 必須與limit一起使用。 |
|
limit |
否 |
Integer |
分頁(yè)查詢每頁(yè)的負(fù)載均衡器個(gè)數(shù)。如果不設(shè)置，則默認(rèn)不分頁(yè)查詢所有。 |
|
page_reverse |
否 |
Boolean |
分頁(yè)的順序，true表示從后往前分頁(yè)，false表示從前往后分頁(yè)，默認(rèn)為false。 必須與limit一起使用。 |
|
id |
否 |
String |
負(fù)載均衡器的ID。 |
|
description |
否 |
String |
負(fù)載均衡器的描述信息。 支持的最大字符長(zhǎng)度：255 |
|
name |
否 |
String |
負(fù)載均衡器的名稱。 支持的最大字符長(zhǎng)度：255 |
|
operating_status |
否 |
String |
負(fù)載均衡器的操作狀態(tài)。取值范圍：可以為ONLINE和FROZEN。 |
|
provisioning_status |
否 |
String |
該字段為預(yù)留字段，暫未啟用。 負(fù)載均衡器的配置狀態(tài)。取值范圍：可以為ACTIVE。 |
|
admin_state_up |
否 |
Boolean |
負(fù)載均衡器的管理狀態(tài)。 該字段為預(yù)留字段，暫未啟用。默認(rèn)為true。 |
|
vip_address |
否 |
String |
負(fù)載均衡器的內(nèi)網(wǎng)IP。 支持的最大字符長(zhǎng)度：64 |
|
vip_port_id |
否 |
String |
負(fù)載均衡器內(nèi)網(wǎng)IP對(duì)應(yīng)的端口ID。 |
|
vip_subnet_id |
否 |
String |
負(fù)載均衡器所在的子網(wǎng)IPv4子網(wǎng)ID。 |
|
member_address |
否 |
String |
負(fù)載均衡器的后端服務(wù)器的IP地址。 |
|
member_device_id |
否 |
String |
負(fù)載均衡器的后端服務(wù)器對(duì)應(yīng)的彈性 云服務(wù)器 ID。 |
|
vpc_id |
否 |
String |
負(fù)載均衡器所在的 虛擬私有云 ID。 |
|
enterprise_project_id |
否 |
String |
企業(yè)項(xiàng)目ID。
|
請(qǐng)求消息
無(wú)
響應(yīng)消息
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
loadbalancers |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
負(fù)載均衡器ID。 |
|
project_id |
String |
負(fù)載均衡器所在項(xiàng)目的ID。 |
|
tenant_id |
String |
負(fù)載均衡器所在項(xiàng)目的ID。 支持的最大字符長(zhǎng)度：255 |
|
name |
String |
負(fù)載均衡器名稱。 支持的最大字符長(zhǎng)度：255 |
|
description |
String |
負(fù)載均衡器的描述信息。 支持的最大字符長(zhǎng)度：255 |
|
vip_subnet_id |
String |
負(fù)載均衡器所在的子網(wǎng)IPv4子網(wǎng)ID。 |
|
vip_port_id |
String |
負(fù)載均衡器內(nèi)網(wǎng)IP對(duì)應(yīng)的端口ID。 |
|
provider |
String |
負(fù)載均衡器的生產(chǎn)者名稱。 |
|
vip_address |
String |
負(fù)載均衡器的內(nèi)網(wǎng)IP。 支持的最大字符長(zhǎng)度：64 |
|
listeners |
Array of Listeners objects |
負(fù)載均衡器關(guān)聯(lián)監(jiān)聽器ID的列表。詳見表6 |
|
pools |
Array of Pools objects |
負(fù)載均衡器關(guān)聯(lián)后端服務(wù)器組ID的列表。詳見表7 |
|
operating_status |
String |
負(fù)載均衡器的操作狀態(tài)。取值范圍：可以為ONLINE和FROZEN。 |
|
provisioning_status |
String |
該字段為預(yù)留字段，暫未啟用。 負(fù)載均衡器的配置狀態(tài)。取值范圍：可以為ACTIVE。 |
|
admin_state_up |
Boolean |
負(fù)載均衡器的管理狀態(tài)。 該字段為預(yù)留字段，暫未啟用。取值范圍：true/false。
|
|
tags |
Array |
負(fù)載均衡器的標(biāo)簽列表。 |
|
created_at |
String |
負(fù)載均衡器的創(chuàng)建時(shí)間。 格式為UTC時(shí)間：YYYY-MM-DDTHH:MM:SS 支持的最大字符長(zhǎng)度：19 |
|
updated_at |
String |
負(fù)載均衡器的更新時(shí)間。 格式為UTC時(shí)間：YYYY-MM-DDTHH:MM:SS 支持的最大字符長(zhǎng)度：19 |
|
enterprise_project_id |
String |
企業(yè)項(xiàng)目ID。創(chuàng)建負(fù)載均衡器時(shí)，給負(fù)載均衡器綁定企業(yè)項(xiàng)目ID。 取值范圍：帶“-”連字符的UUID格式，或者是字符串“0”?！?”表示默認(rèn)企業(yè)項(xiàng)目。 說(shuō)明：
關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息，請(qǐng)參見《企業(yè)管理用戶指南》。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
關(guān)聯(lián)的監(jiān)聽器id |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
關(guān)聯(lián)的后端服務(wù)器組id |
請(qǐng)求示例
- 請(qǐng)求樣例1
GET https://{Endpoint}/v2/1a3e005cf9ce40308c900bcb08e5320c/elb/loadbalancers - 請(qǐng)求樣例2
GET https://{Endpoint}/v2/1a3e005cf9ce40308c900bcb08e5320c/elb/loadbalancers?
limit=10&marker=165b6a38-5278-4569-b747-b2ee65ea84a4
- 請(qǐng)求樣例3
GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/loadbalancers?member_address=192.168.0.198
響應(yīng)示例
- 響應(yīng)樣例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" } ] }
- 響應(yīng)樣例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" } ] }
- 響應(yīng)樣例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" } ] }
返回碼
請(qǐng)參見狀態(tài)碼。
