DescribeHealthStatus API を呼び出して、バックエンドサーバーの正常ステータスを照会できます。
デバッグ
こちら をクリックし、OpenAPI Explorer でデバッグ操作を実行し、SDKコードの例を自動的に生成します。
リクエストパラメータ
パラメータ | データ型 | 必須/省略可能 | 値の例 | 説明 |
---|---|---|---|---|
Action | String | 必須 | DescribeHealthStatus |
この操作の名前です。 有効値: DescribeHealthStatus |
LoadBalancerId | String | 必須 | lb-bp1qjwo61pqz3ahltv0mw |
SLB インスタンスの ID です。 |
RegionId | String | 必須 | cn-hangzhou |
インスタンスが属するリージョン ID です。 |
ListenerPort | Integer | 省略可能 | 80 |
SLB インスタンスに使用されるフロントエンドポートです。 有効値:1–65535 注 ポートを特定しない場合、すべてのポートのヘルスチェックステータスが返されます。
|
レスポンスパラメータ
パラメータ | データ型 | 値の例 | 説明 |
---|---|---|---|
BackendServers |
バックエンドサーバーのリストです。 |
||
└ServerId | String | vm-234 |
ECS インスタンス ID または ENI ID です。 |
└ServerHealthStatus | String | abnormal |
バックエンドサーバーのヘルスチェックステータス:
|
└EniHost | String | 192.168.0.1 |
ENI の IP アドレスです。 |
└ListenerPort | Integer | 80 |
SLB インスタンスに使用されるフロントエンドポートです。 |
└Port | Integer | 70 |
SLB インスタンスに使用されるフロントエンドポートです。 |
└ServerIp | String | 192.168.0.2 |
ECS インスタンスの IP アドレスです。 |
└Type | String | ecs |
バックエンドサーバーの種類です。 有効値:
|
RequestId | String | 365F4154-92F6-4AE4-92F8-7FF34B540710 |
リクエストの ID です。 |
例
リクエストの例
http(s)://[Endpoint]/? Action=DescribeHealthStatus
&LoadBalancerId=lb-bp1qjwo61pqz3ahltv0mw
&<CommonParameters>
通常のレスポンスの例
XML
形式
<DescribeHealthStatusResponse>
<RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
<BackendServers>
<BackendServer>
<ServerId>vm-233</ServerId>
<ServerHealthStatus>normal</ServerHealthStatus>
</BackendServer>
<BackendServer>
<ServerId>vm-234</ServerId>
<ServerHealthStatus>abnormal</ServerHealthStatus>
</BackendServer>
</BackendServers>
</DescribeHealthStatusResponse>
JSON
形式
{
"RequestId":"196EC328-B566-4226-B435-8697723205EF",
"BackendServers":{
"BackendServer":[
{
"ServerId":"i-bp1do02x7n4nua4k72um",
"ServerHealthStatus":"abnormal",
"Port":80,
"ListenerPort":443
}
]
}
}