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

查詢監聽及其轉寄規則的健全狀態檢查狀態。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

alb:GetListenerHealthStatus

get

*LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

無

請求參數

名稱	類型	必填	描述	樣本值
ListenerId	string	是	執行個體的監聽 ID。	lsn-o4u54y73wq7b******
IncludeRule	boolean	否	是否包含轉寄規則的檢查結果。取值： true：是。 false（預設值）：否。	true
NextToken	string	否	是否擁有下一次查詢的令牌（Token）。取值：第一次查詢和沒有下一次查詢時，均無需填寫。如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	否	分批次查詢時每次顯示的最大條目數。取值範圍：1~30，預設值為 20。	20

返回參數

名稱	類型	描述	樣本值
	object	查詢監聽及其相應配置的轉寄規則的健全狀態檢查狀態。
ListenerHealthStatus	array<object>	監聽的伺服器組健全狀態檢查狀態列表。
	array<object>	監聽的伺服器組健全狀態檢查狀態結構。
ListenerId	string	執行個體的監聽 ID。	lsn-o4u54y73wq7b******
ListenerPort	integer	監聽的連接埠號碼。	80
ListenerProtocol	string	監聽的協議。	http
ServerGroupInfos	array<object>	伺服器組資訊。
	array<object>	伺服器組資訊。
HealthCheckEnabled	string	健全狀態檢查開啟狀態。取值： on，表示開啟健全狀態檢查。	on
NonNormalServers	array<object>	非正常狀態的後端伺服器列表。
	array<object>	非正常狀態的後端伺服器列表。
Port	integer	後端伺服器連接埠。	90
Reason	object	非正常狀態的原因。
ActualResponse	string	後端伺服器實際的返回碼資訊，例如，302。說明 ReasonCode 為RESPONSE_MISMATCH才該傳回值。	302
ExpectedResponse	string	使用者預期的後端伺服器返回碼資訊。取值：HTTP_2xx、HTTP_3xx、HTTP_4xx和HTTP_5xx。多個返回碼之間用半形逗號（,）分隔。說明 ReasonCode 為RESPONSE_MISMATCH才返回該值。	HTTP_2xx
ReasonCode	string	Status 為異常狀態時的詳細原因。目前僅 HTTP 和 HTTPS 的監聽與轉寄規則支援查看異常狀態原因： CONNECT_TIMEOUT：負載平衡健全狀態檢查時向後端伺服器建立連線逾時。 CONNECT_FAILED：負載平衡健全狀態檢查時向後端伺服器建立串連失敗。 RECV_RESPONSE_FAILED：負載平衡健全狀態檢查時從後端伺服器接收響應失敗。 RECV_RESPONSE_TIMEOUT：負載平衡健全狀態檢查時從後端伺服器接收響應逾時。 SEND_REQUEST_FAILED：負載平衡健全狀態檢查時向後端伺服器發送請求失敗。 SEND_REQUEST_TIMEOUT：負載平衡健全狀態檢查時向後端伺服器發送請求逾時。 RESPONSE_FORMAT_ERROR：負載平衡健全狀態檢查時從後端伺服器接收響應格式錯誤。 RESPONSE_MISMATCH：負載平衡健全狀態檢查時從後端伺服器接收的響應碼與預期配置返回碼不一致。	RESPONSE_MISMATCH
ServerId	string	後端伺服器 ID。	i-uf62h8v******
ServerIp	string	後端伺服器 IP。	192.168.8.10
Status	string	健全狀態檢查狀態。取值： Initial：初始化中，表示Server Load Balancer執行個體配置了健全狀態檢查，但查不到資料。 Unhealthy：異常，表示連續上報不健康的狀態。 Unused：未使用，表示後端伺服器的權重為 0。 Unavailable：未開啟，表示未開啟健全狀態檢查。	Initial
ServerGroupId	string	關聯的伺服器組 ID。	sgp-8ilqs4axp6******
ActionType	string	伺服器組使用類型。取值： ForwardGroup：轉寄至伺服器組。 TrafficMirror：流量鏡像至伺服器組。	TrafficMirror
RequestId	string	請求 ID。	CEF72CEB-54B6-4AE8-B225-F876F******
RuleHealthStatus	array<object>	轉寄規則的健康狀態列表。
	array<object>	轉寄規則的健康狀態結構。
RuleId	string	轉寄規則 ID。	rule-hp34s2h0xx1ht4nwo****
ServerGroupInfos	array<object>	伺服器組列表。
	array<object>	伺服器組結構。
HealthCheckEnabled	string	健全狀態檢查開啟狀態。取值： on，表示開啟健全狀態檢查。	on
NonNormalServers	array<object>	非正常狀態的後端伺服器列表。
	array<object>	非正常狀態的後端伺服器列表。
Port	integer	後端伺服器連接埠。	90
Reason	object	非正常狀態的原因。
ActualResponse	string	後端伺服器實際的返回碼資訊，例如，302。說明 ReasonCode 為RESPONSE_MISMATCH才有值。	302
ExpectedResponse	string	使用者預期的後端伺服器返回碼資訊。取值：HTTP_2xx、HTTP_3xx、HTTP_4xx和HTTP_5xx。多個返回碼之間用半形逗號（,）分隔。說明 ReasonCode 為RESPONSE_MISMATCH才有值。	HTTP_2xx
ReasonCode	string	Status 為異常狀態時的詳細原因。目前僅 HTTP 和 HTTPS 的監聽與轉寄規則支援查看異常狀態原因： CONNECT_TIMEOUT：負載平衡健全狀態檢查時向後端伺服器建立連線逾時。 CONNECT_FAILED：負載平衡健全狀態檢查時向後端伺服器建立串連失敗。 RECV_RESPONSE_FAILED：負載平衡健全狀態檢查時從後端伺服器接收響應失敗。 RECV_RESPONSE_TIMEOUT：負載平衡健全狀態檢查時從後端伺服器接收響應逾時。 SEND_REQUEST_FAILED：負載平衡健全狀態檢查時向後端伺服器發送請求失敗。 SEND_REQUEST_TIMEOUT：負載平衡健全狀態檢查時向後端伺服器發送請求逾時。 RESPONSE_FORMAT_ERROR：負載平衡健全狀態檢查時從後端伺服器接收響應格式錯誤。 RESPONSE_MISMATCH：負載平衡健全狀態檢查時從後端伺服器接收的響應碼與預期配置返回碼不一致。	RESPONSE_MISMATCH
ServerId	string	後端伺服器 ID。	i-uf62h8v******
ServerIp	string	後端伺服器組 IP。	192.168.2.11
Status	string	健全狀態檢查狀態。取值： Initial：初始化中，表示Server Load Balancer執行個體配置了健全狀態檢查，但查不到資料。 Unhealthy：異常，表示連續上報不健康的狀態。 Unused：未使用，表示後端伺服器的權重為 0 或當您設定關閉跨 AZ 負載平衡，且後端伺服器與 ALB 不在相同可用性區域。 Unavailable：未開啟，表示未開啟健全狀態檢查。	Initial
ServerGroupId	string	關聯的伺服器組 ID。	sgp-8ilqs4axp6******
ActionType	string	伺服器組使用類型。	TrafficMirror
NextToken	string	是否擁有下一次查詢的令牌（Token）。取值：如果 NextToken 為空白表示沒有下一次查詢。如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****

樣本

正常返回樣本

JSON格式

{
  "ListenerHealthStatus": [
    {
      "ListenerId": "lsn-o4u54y73wq7b******",
      "ListenerPort": 80,
      "ListenerProtocol": "http",
      "ServerGroupInfos": [
        {
          "HealthCheckEnabled": "on",
          "NonNormalServers": [
            {
              "Port": 90,
              "Reason": {
                "ActualResponse": "302",
                "ExpectedResponse": "HTTP_2xx",
                "ReasonCode": "RESPONSE_MISMATCH"
              },
              "ServerId": "i-uf62h8v******",
              "ServerIp": "192.168.8.10",
              "Status": "Initial"
            }
          ],
          "ServerGroupId": "sgp-8ilqs4axp6******",
          "ActionType": "TrafficMirror"
        }
      ]
    }
  ],
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876F******",
  "RuleHealthStatus": [
    {
      "RuleId": "rule-hp34s2h0xx1ht4nwo****",
      "ServerGroupInfos": [
        {
          "HealthCheckEnabled": "on",
          "NonNormalServers": [
            {
              "Port": 90,
              "Reason": {
                "ActualResponse": "302",
                "ExpectedResponse": "HTTP_2xx",
                "ReasonCode": "RESPONSE_MISMATCH"
              },
              "ServerId": "i-uf62h8v******",
              "ServerIp": "192.168.2.11",
              "Status": "Initial"
            }
          ],
          "ServerGroupId": "sgp-8ilqs4axp6******",
          "ActionType": "TrafficMirror"
        }
      ]
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	Forbidden.LoadBalancer	Authentication is failed for %s.	負載平衡操作鑒權失敗。
404	ResourceNotFound.LoadBalancer	The specified resource %s is not found.	資源%s不存在。
404	ResourceNotFound.Listener	The specified resource %s is not found.	監聽不存在。

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

變更歷史

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