華為云計(jì)算 云知識(shí) 查詢后端云服務(wù)器組列表ListPools
查詢后端云服務(wù)器組列表ListPools

 

功能介紹

查詢后端 云服務(wù)器 組列表。支持過(guò)濾查詢和分頁(yè)查詢。如未特殊說(shuō)明,匹配規(guī)則為精確匹配。

調(diào)試

您可以在API Explorer中直接運(yùn)行調(diào)試該接口。

URI

GET /v2/{project_id}/elb/pools

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

操作用戶的項(xiàng)目ID。

獲取方法詳見(jiàn)獲取項(xiàng)目ID

表2 查詢參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

marker

String

分頁(yè)查詢的起始的資源ID,表示上一頁(yè)最后一條查詢記錄的后端云服務(wù)器組的ID。不指定時(shí)表示查詢第一頁(yè)。

必須與limit一起使用。

limit

Integer

分頁(yè)查詢每頁(yè)的后端云服務(wù)器組個(gè)數(shù)。如果不設(shè)置,則默認(rèn)不分頁(yè)查詢所有。

page_reverse

Boolean

分頁(yè)的順序,true表示從后往前分頁(yè),false表示從前往后分頁(yè),默認(rèn)為false。

必須與limit一起使用。

id

String

后端云服務(wù)器組ID。

name

String

后端云服務(wù)器組名稱。

支持的最大字符長(zhǎng)度:255

description

String

后端云服務(wù)器組的描述信息。

支持的最大字符長(zhǎng)度:255

healthmonitor_id

String

后端云服務(wù)器組關(guān)聯(lián)的健康檢查的ID。

loadbalancer_id

String

后端云服務(wù)器組關(guān)聯(lián)的 負(fù)載均衡 器ID。

protocol

String

后端云服務(wù)器組的后端協(xié)議。

支持TCP、UDP和HTTP。

lb_algorithm

String

后端云服務(wù)器組的負(fù)載均衡算法。

取值范圍:
  • ROUND_ROBIN:加權(quán)輪詢算法。
  • LEAST_CONNECTIONS:加權(quán)最少連接算法。
  • SOURCE_IP:源IP算法。

當(dāng)該字段的取值為SOURCE_IP時(shí),后端云服務(wù)器組綁定的后端云服務(wù)器的weight字段無(wú)效。

member_address

String

后端云服務(wù)器組關(guān)聯(lián)的后端云服務(wù)器IP。

member_device_id

String

后端云服務(wù)器組關(guān)聯(lián)的后端云服務(wù)器對(duì)應(yīng)的彈性云服務(wù)器的ID。

enterprise_project_id

String

企業(yè)項(xiàng)目ID,僅用于基于企業(yè)項(xiàng)目的細(xì)粒度鑒權(quán)使用。

  • 如果參數(shù)中傳遞了loadbalancer_id,則用該負(fù)載均衡器對(duì)應(yīng)企業(yè)項(xiàng)目ID鑒權(quán)。
  • 如果參數(shù)中沒(méi)有傳遞loadbalancer_id,而傳遞了healthmonitor_id,則使用健康檢查器對(duì)應(yīng)的企業(yè)項(xiàng)目id鑒權(quán)。
  • 如果enterprise_project_id、loadbalancer_id、healthmonitor_id都沒(méi)傳遞,則默認(rèn)進(jìn)行細(xì)粒度鑒權(quán),必須在用戶組下分配elb:*list權(quán)限才能通過(guò)鑒權(quán)。

請(qǐng)求消息

無(wú)

響應(yīng)消息

表3 響應(yīng)參數(shù)

參數(shù)

參數(shù)類型

描述

pools

Array of Pools objects

后端云服務(wù)器組對(duì)象列表。詳見(jiàn)表4。

表4 pool字段說(shuō)明

參數(shù)

參數(shù)類型

描述

id

String

后端云服務(wù)器組 ID。

tenant_id

String

后端云服務(wù)器組所屬的項(xiàng)目 ID。

支持的最大字符長(zhǎng)度:255

project_id

String

此參數(shù)和tenant_id參數(shù)含義一樣,均指后端云服務(wù)器組所屬的項(xiàng)目 ID。

name

String

后端云服務(wù)器組名稱。

支持的最大字符長(zhǎng)度:255

description

String

后端云服務(wù)器組的描述信息。

支持的最大字符長(zhǎng)度:255

protocol

String

后端云服務(wù)器組的后端協(xié)議。

取值范圍:TCP、UDP和HTTP。

當(dāng)指定listener_id創(chuàng)建后端云服務(wù)器組時(shí),后端云服務(wù)器組的protocol和它關(guān)聯(lián)的監(jiān)聽(tīng)器的protocol有如下關(guān)系:

  • 監(jiān)聽(tīng)器的protocol為UDP時(shí),后端云服務(wù)器組的protocol必須為UDP;
  • 監(jiān)聽(tīng)器的protocol為TCP時(shí),后端云服務(wù)器組的protocol必須為TCP;
  • 監(jiān)聽(tīng)器的protocol為HTTP或TERMINATED_HTTPS時(shí),后端云服務(wù)器組的protocol必須為HTTP。

lb_algorithm

String

后端云服務(wù)器組的負(fù)載均衡算法。

取值范圍:
  • ROUND_ROBIN:加權(quán)輪詢算法。
  • LEAST_CONNECTIONS:加權(quán)最少連接算法。
  • SOURCE_IP:源IP算法。當(dāng)該字段的取值為SOURCE_IP時(shí),后端云服務(wù)器組綁定的后端云服務(wù)器的weight字段無(wú)效。

members

Array of Members objects

后端云服務(wù)器組關(guān)聯(lián)的后端云服務(wù)器ID的列表。詳見(jiàn)表7

healthmonitor_id

String

后端云服務(wù)器組關(guān)聯(lián)的健康檢查的ID。

admin_state_up

Boolean

后端云服務(wù)器組的管理狀態(tài)。

該字段為預(yù)留字段,暫未啟用。取值范圍:true/false。

  • true表示開(kāi)啟。
  • false表示關(guān)閉。

listeners

Array of Listeners objects

后端云服務(wù)器組關(guān)聯(lián)的監(jiān)聽(tīng)器ID列表。詳見(jiàn)表8

loadbalancers

Array of Loadbalancers objects

后端云服務(wù)器組關(guān)聯(lián)的負(fù)載均衡器ID列表。詳見(jiàn)表9

session_persistence

SessionPersistence object

后端云服務(wù)器組的會(huì)話持久性。詳見(jiàn)表10。

當(dāng)開(kāi)啟會(huì)話保持后,在一定時(shí)間內(nèi),來(lái)自同一客戶端的請(qǐng)求會(huì)發(fā)送到同一個(gè)后端云服務(wù)器上。

取值范圍:當(dāng)會(huì)話保持關(guān)閉時(shí),該字段取值為null。

表5 members字段說(shuō)明

參數(shù)

參數(shù)類型

描述

id

String

關(guān)聯(lián)的后端服務(wù)器id

表6 listeners字段說(shuō)明

參數(shù)

參數(shù)類型

描述

id

String

關(guān)聯(lián)的后端服務(wù)器組id

表7 loadbalancers字段說(shuō)明

參數(shù)

參數(shù)類型

描述

id

String

關(guān)聯(lián)的負(fù)載均衡器id

表8 session_persistence字段說(shuō)明

參數(shù)

是否必選

參數(shù)類型

描述

type

String

會(huì)話保持的類型。

取值范圍:
  • SOURCE_IP:根據(jù)請(qǐng)求的源IP,將同一IP的請(qǐng)求發(fā)送到同一個(gè)后端云服務(wù)器上。
  • HTTP_COOKIE:客戶端第一次發(fā)送請(qǐng)求時(shí),負(fù)載均衡器自動(dòng)生成cookie并將該cookie插入響應(yīng)消息中,后續(xù)請(qǐng)求會(huì)發(fā)送到處理第一個(gè)請(qǐng)求的后端云服務(wù)器上。
  • APP_COOKIE:客戶端第一次發(fā)送請(qǐng)求時(shí),后端服務(wù)器生成cookie并將該cookie插入響應(yīng)消息中,后續(xù)請(qǐng)求會(huì)發(fā)送到處理第一個(gè)請(qǐng)求的后端云服務(wù)器上。

當(dāng)后端云服務(wù)器組的protocol為TCP時(shí),只按SOURCE_IP生效;當(dāng)后端云服務(wù)器組的protocol為HTTP時(shí),只按HTTP_COOKIE、APP_COOKIE生效。

cookie_name

String

cookie名稱。支持字母、數(shù)字、中劃線(-)和下劃線(_),最大長(zhǎng)度64個(gè)字符。

當(dāng)會(huì)話保持類型是APP_COOKIE時(shí),為必選字段,其它類型時(shí)不可指定。

persistence_timeout

Integer

會(huì)話保持的超時(shí)時(shí)間。

當(dāng)type為APP_COOKIE時(shí)不生效。

取值范圍:
  • [1,60](分鐘):當(dāng)后端云服務(wù)器組的protocol為TCP、UDP時(shí)。
  • [1,1440](分鐘):當(dāng)后端云服務(wù)器組的protocol為HTTP、HTTPS時(shí)。

請(qǐng)求示例

  • 請(qǐng)求樣例1 全量查詢后端云服務(wù)器組
    GET https://{Endpoint}/v2/1867112d054b427e808cc6096d8193a1/elb/pools
  • 請(qǐng)求樣例2 過(guò)濾查詢負(fù)載均衡算法為SOURCE_IP的后端云服務(wù)器組
    GET https://{Endpoint}/v2/1867112d054b427e808cc6096d8193a1/elb/pools?lb_algorithm=SOURCE_IP

響應(yīng)示例

  • 響應(yīng)樣例1
    {
        "pools": [
            {
                "lb_algorithm": "SOURCE_IP",
                "protocol": "TCP",
                "description": "",
                "admin_state_up": true,
                "loadbalancers": [
                    {
                        "id": "07d28d4a-4899-40a3-a939-5d09d69019e1"
                    }
                ],
                "tenant_id": "1867112d054b427e808cc6096d8193a1",
                "project_id": "1867112d054b427e808cc6096d8193a1",
                "session_persistence": null,
                "healthmonitor_id": null,
                "listeners": [
                    {
                        "id": "1b421c2d-7e78-4a78-9ee4-c8ccba41f15b"
                    }
                ],
                "members": [
                    {
                        "id": "88f9c079-29cb-435a-b98f-0c5c0b90c2bd"
                    },
                    {
                        "id": "2f4c9644-d5d2-4cf8-a3c0-944239a4f58c"
                    }
                ],
                "id": "3a9f50bb-f041-4eac-a117-82472d8a0007",
                "name": "my-pool"
            }
        ]
    }
  • 響應(yīng)樣例2
    {
        "pools": [
            {
                "lb_algorithm": "SOURCE_IP",
                "protocol": "TCP",
                "description": "",
                "admin_state_up": true,
                "loadbalancers": [
                    {
                        "id": "07d28d4a-4899-40a3-a939-5d09d69019e1"
                    }
                ],
                "tenant_id": "1867112d054b427e808cc6096d8193a1",
                "project_id": "1867112d054b427e808cc6096d8193a1",
                "session_persistence": null,
                "healthmonitor_id": null,
                "listeners": [
                    {
                        "id": "1b421c2d-7e78-4a78-9ee4-c8ccba41f15b"
                    }
                ],
                "members": [
                    {
                        "id": "88f9c079-29cb-435a-b98f-0c5c0b90c2bd"
                    },
                    {
                        "id": "2f4c9644-d5d2-4cf8-a3c0-944239a4f58c"
                    }
                ],
                "id": "3a9f50bb-f041-4eac-a117-82472d8a0007",
                "name": "my-pool"
            }
        ]
    }

返回碼

請(qǐng)參見(jiàn)狀態(tài)碼