華為云計(jì)算 云知識 查詢負(fù)載均衡狀態(tài)樹ShowLoadbalancersStatus
查詢負(fù)載均衡狀態(tài)樹ShowLoadbalancersStatus

 

功能介紹

查詢 負(fù)載均衡 器狀態(tài)樹??赏ㄟ^該接口查詢負(fù)載均衡器關(guān)聯(lián)的監(jiān)聽器、后端 云服務(wù)器 組、后端云服務(wù)器、健康檢查、轉(zhuǎn)發(fā)策略、轉(zhuǎn)發(fā)規(guī)則的主要信息,了解負(fù)載均衡器下資源的拓?fù)淝闆r。

調(diào)試

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

URI

GET /v2/{project_id}/elb/loadbalancers/{loadbalancer_id}/statuses

表1 參數(shù)說明

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

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

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

loadbalancer_id

String

負(fù)載均衡器id。

請求消息

響應(yīng)消息

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

參數(shù)

參數(shù)類型

描述

statuses

Statuses object

負(fù)載均衡器狀態(tài)樹。詳見表3。

表3 statuses字段說明

參數(shù)

參數(shù)類型

描述

loadbalancer

Loadbalancer object

負(fù)載均衡器對象。詳見表4。

表4 loadbalancer字段說明

參數(shù)

參數(shù)類型

描述

id

String

負(fù)載均衡器ID。

name

String

負(fù)載均衡器名稱。

支持的最大字符長度:255

listeners

Array of Listeners objects

負(fù)載均衡器關(guān)聯(lián)的監(jiān)聽器列表。listeners對象參考表5。

pools

Array of Pools objects

負(fù)載均衡器關(guān)聯(lián)的后端服務(wù)器組列表。pools對象參考表6。

operating_status

String

該字段為預(yù)留字段,目前暫未使用。

負(fù)載均衡器的操作狀態(tài)。取值范圍:

  • ONLINE:創(chuàng)建時(shí)的默認(rèn)狀態(tài),表示負(fù)載均衡器正常。
  • DEGRADED:該負(fù)載均衡器下存在l7policy或l7rule的Provisioning_status為ERROR時(shí)返回此狀態(tài)。注意該狀態(tài)僅在當(dāng)前接口中返回。
  • DISABLED:負(fù)載均衡器的admin_state_up屬性值為false時(shí)會返回該狀態(tài)。注意該狀態(tài)僅在當(dāng)前接口中返回。
  • FROZEN:負(fù)載均衡器被凍結(jié)。

provisioning_status

String

該字段為預(yù)留字段,暫未啟用。

負(fù)載均衡器的配置狀態(tài)。取值范圍:可以為ACTIVE。

表5 listeners字段說明

參數(shù)

參數(shù)類型

描述

id

String

監(jiān)聽器ID。

name

String

監(jiān)聽器名稱。

l7policies

Array of l7policies objects

監(jiān)聽器關(guān)聯(lián)的轉(zhuǎn)發(fā)策略列表,l7policy對象參考表9。

pools

Array of Pools objects

監(jiān)聽器關(guān)聯(lián)的后端云服務(wù)器組列表,pools對象參考表6。

operating_status

String

監(jiān)聽器的操作狀態(tài)。取值范圍:ONLINE 表示監(jiān)聽器正常。

provisioning_status

String

該字段為預(yù)留字段,暫未啟用。

監(jiān)聽器的配置狀態(tài)。取值范圍:可以為ACTIVE。

表6 pools字段說明

參數(shù)

參數(shù)類型

描述

id

String

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

name

String

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

healthmonitor

Healthmonitor object

后端服務(wù)器組的健康檢查詳情,健康檢查對象參考表7。

members

Array of Members objects

后端服務(wù)器組中包含的后端服務(wù)器列表,后端服務(wù)器對象參考表8。

operating_status

String

后端服務(wù)器組的操作狀態(tài)。取值范圍:ONLINE 表示后端服務(wù)器組正常。

provisioning_status

String

該字段為預(yù)留字段,暫未啟用。

后端服務(wù)器組的配置狀態(tài)。取值范圍:可以為ACTIVE。

表7 healthmonitor字段說明

參數(shù)

參數(shù)類型

描述

id

String

健康檢查ID。

name

String

健康檢查名稱。

type

String

  • 健康檢查類型。
  • 取值范圍:UDP_CONNECT、TCP、HTTP。

provisioning_status

String

該字段為預(yù)留字段,暫未啟用。

健康檢查的配置狀態(tài)。取值范圍:可以為ACTIVE。

表8 members字段說明

參數(shù)

參數(shù)類型

描述

id

String

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

address

String

后端云服務(wù)器的IP地址。

例如:"192.168.3.11"。

protocol_port

Integer

  • 后端服務(wù)器的端口號。
  • 取值范圍:[0,65535]。

operating_status

String

后端云服務(wù)器的操作狀態(tài)。取值范圍:

  • ONLINE:后端服務(wù)器正常運(yùn)行。
  • NO_MONITOR:后端服務(wù)器無健康檢查。
  • DISABLED:后端服務(wù)器不可用。所屬負(fù)載均衡器、后端服務(wù)器組或該后端服務(wù)器的admin_state_up=false時(shí),會顯示該狀態(tài)。注意該狀態(tài)僅在當(dāng)前接口中返回。
  • OFFLINE:關(guān)聯(lián)的ECS已下線。
說明:

該接口中的operating_status不一定與對應(yīng)資源的operating_status相同。如:當(dāng)Member的admin_state_up=false且operating_status=OFFLINE時(shí),該接口返回member的operating_status=DISABLE。

provisioning_status

String

該字段為預(yù)留字段,暫未啟用。

后端服務(wù)器的配置狀態(tài)。取值范圍:可以為ACTIVE。

表9 l7policies字段說明

參數(shù)

參數(shù)類型

描述

id

String

轉(zhuǎn)發(fā)策略ID。

name

String

轉(zhuǎn)發(fā)策略名稱。

rules

Array of Rules objects

轉(zhuǎn)發(fā)策略關(guān)聯(lián)的轉(zhuǎn)發(fā)規(guī)則列表,轉(zhuǎn)發(fā)規(guī)則字段參考表10。

action

String

  • 轉(zhuǎn)發(fā)策略的轉(zhuǎn)發(fā)動作;
  • 取值范圍:REDIRECT_TO_POOL:轉(zhuǎn)發(fā)到后端服務(wù)器組,REDIRECT_TO_LISTENER:重定向到監(jiān)聽器。

provisioning_status

String

該字段為預(yù)留字段,暫未啟用。

轉(zhuǎn)發(fā)策略的配置狀態(tài)。取值范圍:

  • ACTIVE:默認(rèn)值,表示正常。
  • ERROR:表示當(dāng)前策略與同一監(jiān)聽器下的其他策略存在相同的規(guī)則配置。
表10 rules字段說明

參數(shù)

參數(shù)類型

描述

id

String

轉(zhuǎn)發(fā)規(guī)則ID。

type

String

  • 轉(zhuǎn)發(fā)規(guī)則的匹配內(nèi)容。
  • 取值范圍:PATH或者HOST_NAME。PATH:匹配請求中的路徑,HOST_NAME:匹配請求中的域名。

provisioning_status

String

該字段為預(yù)留字段,暫未啟用。

轉(zhuǎn)發(fā)規(guī)則的配置狀態(tài)。取值范圍:

  • ACTIVE:默認(rèn)值,表示正常。
  • ERROR:表示當(dāng)前規(guī)則所屬策略與同一監(jiān)聽器下的其他策略存在相同的規(guī)則配置。

請求示例

  • 請求樣例
    GET https://{Endpoint}/v2/145483a5107745e9b3d80f956713e6a3/elb/loadbalancers/
    38278031-cfca-44be-81be-a412f618773b/statuses

響應(yīng)示例

  • 響應(yīng)樣例
    {
        "statuses": {
            "loadbalancer": {
                "name": "lb-jy",
                "provisioning_status": "ACTIVE",
                "listeners": [
                    {
                        "name": "listener-jy-1",
                        "provisioning_status": "ACTIVE",
                        "pools": [
                            {
                                "name": "pool-jy-1",
                                "provisioning_status": "ACTIVE",
                                "healthmonitor": {
                                    "type": "TCP",
                                    "id": "7422b51a-0ed2-4702-9429-4f88349276c6",
                                    "name": "",
                                    "provisioning_status": "ACTIVE"
                                },
                                "members": [
                                    {
                                        "protocol_port": 80,
                                        "address": "192.168.44.11",
                                        "id": "7bbf7151-0dce-4087-b316-06c7fa17b894",
                                        "operating_status": "ONLINE",
                                        "provisioning_status": "ACTIVE"
                                    }
                                ],
                                "id": "c54b3286-2349-4c5c-ade1-e6bb0b26ad18",
                                "operating_status": "ONLINE"
                            }
                        ],
                        "l7policies": [],
                        "id": "eb84c5b4-9bc5-4bee-939d-3900fb05dc7b",
                        "operating_status": "ONLINE"
                    }
                ],
                "pools": [
                    {
                        "name": "pool-jy-1",
                        "provisioning_status": "ACTIVE",
                        "healthmonitor": {
                            "type": "TCP",
                            "id": "7422b51a-0ed2-4702-9429-4f88349276c6",
                            "name": "",
                            "provisioning_status": "ACTIVE"
                        },
                        "members": [
                            {
                                "protocol_port": 80,
                                "address": "192.168.44.11",
                                "id": "7bbf7151-0dce-4087-b316-06c7fa17b894",
                                "operating_status": "ONLINE",
                                "provisioning_status": "ACTIVE"
                            }
                        ],
                        "id": "c54b3286-2349-4c5c-ade1-e6bb0b26ad18",
                        "operating_status": "ONLINE"
                    }
                ],
                "id": "38278031-cfca-44be-81be-a412f618773b",
                "operating_status": "ONLINE"
            }
        }
    }

返回碼

請參見狀態(tài)碼。