GetListenerHealthStatus - 查詢監聽健全狀態檢查狀態 - Server Load Balancer

查詢Server Load Balancer執行個體監聽的健全狀態檢查狀態。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

gwlb:GetListenerHealthStatus

get

*LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadbalancerId}

*Listener

acs:gwlb:{#regionId}:{#accountId}:listener/{#ListenerId}

無

請求參數

名稱	類型	必填	描述	樣本值
ListenerId	string	是	監聽 ID。	lsn-7sixpvm5fc3v0b****
NextToken	string	否	是否擁有下一次查詢的令牌（Token）。取值：如果 NextToken 為空白表示沒有下一次查詢。如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。	4f1d7cc9f51e18904e8a063603a6b0c3d03bc69f78734254e0b5e8707e68****
MaxResults	integer	否	分批次查詢時每次顯示的條目數。取值範圍：1~1000，預設值為 20。	20
Skip	integer	否	分頁查詢時，跳過的條目數。	10
Filter	array<object>	否	動態查詢條件列表。一次最多添加 20 個動態查詢條件。
	object	否	動態查詢條件。
Name	string	否	動態查詢條件名稱，可選擇一個或者多個名稱進行查詢。取值範圍： Status：健全狀態檢查狀態。 ReasonCode：Status 為異常狀態時的詳細原因。 ServerId：後端伺服器 ID。 ServerIp：後端伺服器 IP 位址。	Status
Values	array	否	動態查詢條件的值列表。一次最多添加 20 個值。
	string	否	動態查詢條件的值。取值範圍參考返回參數中相應欄位的取值。	Unhealthy

返回參數

名稱	類型	描述	樣本值
	object	請求的傳回值。
ListenerHealthStatus	array<object>	監聽的伺服器組健全狀態檢查狀態列表。
	array<object>	監聽的伺服器組健全狀態檢查狀態結構。
ListenerId	string	監聽 ID。	lsn-sg8aha6pzjavvo****
ServerGroupInfos	array<object>	伺服器組資訊列表。
	array<object>	伺服器組資訊。
HealthCheckEnabled	boolean	是否開啟健全狀態檢查。取值： true：開啟。 false：關閉。	true
ServerGroupId	string	伺服器組 ID。	sgp-0vdsbyszro3nr6****
Servers	array<object>	後端伺服器列表。
	array<object>	後端伺服器。
Port	integer	後端伺服器連接埠。	6081
Reason	object	Status 為異常狀態時的詳細原因。
ReasonCode	string	Status 為異常狀態時的詳細原因，取值： CONNECT_TIMEOUT：負載平衡健全狀態檢查時向後端伺服器建立連線逾時。 CONNECT_FAIL：負載平衡健全狀態檢查時向後端伺服器建立串連失敗。 RECV_TIMEOUT：負載平衡健全狀態檢查時從後端伺服器接收響應逾時。 CONNECT_INTERRUPT：負載平衡健全狀態檢查與後端伺服器串連中斷。 HTTP_CODE_NOT_MATCH：負載平衡健康 HTTP 檢查時從後端伺服器接收的響應碼與預期配置返回碼不一致。 HTTP_INVALID_HEADER：負載平衡健康 HTTP 檢查時從後端伺服器接收響應格式錯誤。	CONNECT_TIMEOUT
ServerId	string	後端伺服器 ID。	i-2ze4rnh8yj9kif3z****
ServerIp	string	後端伺服器 IP。	192.168.0.XXX
Status	string	後端伺服器健全狀態檢查狀態。取值： Initial：初始化中，表示Server Load Balancer執行個體配置了健全狀態檢查，但查不到資料。 Unhealthy：異常，表示連續上報不健康的狀態。 Unused：未使用; Unavailable：未開啟，表示未開啟健全狀態檢查； Healthy：健全狀態檢查正常；	Healthy
MaxResults	integer	分批次查詢時每次顯示的條目數。取值範圍：1~1000，預設值為 20。	20
NextToken	string	是否擁有下一次查詢的令牌（Token）。取值：如果 NextToken 為空白表示沒有下一次查詢。如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。	U12WEI6Ro2ol3wA54rBNSwdC5+lYy6q5SjIQEvc1wz5mjZxV+YjsHRdXV8XauY1BpOQIvwX63E0en54H3D****
RequestId	string	請求 ID。	0ED4F222-36A0-5470-8A9A-AAB4E96BAC1A
TotalCount	integer	本次請求條件下的資料總量。	31

樣本

正常返回樣本

JSON格式

{
  "ListenerHealthStatus": [
    {
      "ListenerId": "lsn-sg8aha6pzjavvo****",
      "ServerGroupInfos": [
        {
          "HealthCheckEnabled": true,
          "ServerGroupId": "sgp-0vdsbyszro3nr6****",
          "Servers": [
            {
              "Port": 6081,
              "Reason": {
                "ReasonCode": "CONNECT_TIMEOUT"
              },
              "ServerId": "i-2ze4rnh8yj9kif3z****",
              "ServerIp": "192.168.0.XXX",
              "Status": "Healthy"
            }
          ]
        }
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "U12WEI6Ro2ol3wA54rBNSwdC5+lYy6q5SjIQEvc1wz5mjZxV+YjsHRdXV8XauY1BpOQIvwX63E0en54H3D****",
  "RequestId": "0ED4F222-36A0-5470-8A9A-AAB4E96BAC1A",
  "TotalCount": 31
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IllegalParam.FilterValue	The param of %s is illegal.	動態查詢條件的值非法
400	IllegalParam.FilterName	The param of %s is illegal.	動態查詢條件名稱非法
404	ResourceNotFound.Listener	The specified resource of %s is not found.	指定的監聽資源不存在

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。