edit-icon download-icon

DescribeHealthStatus

最終更新日: Apr 17, 2018

説明

バックエンドサーバーの正常性状態を照会します。

リクエストパラメータ

名前 必須かどうか 説明
Action String はい 実行するアクション。有効な値: DescribeHealthStatus
RegionId String はい SLB インスタンスが配置されているリージョンの ID。
LoadBalancerId String はい SLB インスタンスの ID。
ListenerPort Integer いいえ リスナーのフロントエンドポート。有効な値:[1,65535] 注意: ポートが指定されていない場合、すべてのリスナーのヘルスチェックが返されます。

レスポンスパラメータ

名前 説明
LoadBalancerId String

Server Load Balancer インスタンスの ID。

BackendServers JSON String 以下を含むバックエンドサーバーのリスト。
  • ServerId: ECS インスタンスの ID。

  • ServerHealthStatus: バックエンドサーバの状態:

    • normal: バックエンドサーバーの状態は正常です。

    • abnormal: バックエンドサーバーの状態が異常です。

    • unavailable: バックエンドサーバーのステータスを取得できません。ヘルスチェックが終了していないか、リスナーがヘルスチェックを設定していない可能性があります。

リクエストの例

  1. https://slb.aliyuncs.com/?Action=DescribeHealthStatus
  2. &LoadBalancerId=139a00604ad-cn-east-hangzhou-01
  3. &ListenerPort=80
  4. &<CommonParameters>

レスポンスの例

  • XML 形式

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <DescribeHealthStatusResponse>
    3. <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    4. <BackendServers>
    5. <BackendServer>
    6. <ServerId>vm-233</ServerId>
    7. <ServerHealthStatus>normal</ServerHealthStatus>
    8. </BackendServer>
    9. <BackendServer>
    10. <ServerId>vm-234</ServerId>
    11. <ServerHealthStatus>abnormal</ServerHealthStatus>
    12. </BackendServer>
    13. </BackendServers>
    14. </DescribeHealthStatusResponse>
  • JSON 形式

    1. {
    2. "RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710",
    3. "LoadBalancerId":"139a00604ad-cn-east-hangzhou-01",
    4. "BackendServers":{
    5. BackendServer”: [
    6. {"ServerId": "vm-233", "ServerHealthStatus:"normal"},
    7. {“ServerId": "vm-234", "ServerHealthStatus:"abnormal"}
    8. ]
    9. }
    10. }