DescribeHealthStatus - - Alibaba Cloud ドキュメントセンター

バックエンドサーバーのヘルスステータスを照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

slb:DescribeHealthStatus

get

*loadbalancer

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

slb:tag
slb:tag
slb:tag
slb:tag
slb:tag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
LoadBalancerId	string	必須	Classic Load Balancer (CLB) インスタンスの ID。	lb-bp1qjwo61pqz3ah****
ListenerPort	integer	任意	SLB インスタンスが使用するフロントエンドポート。有効な値：1～65535。説明このパラメーターを指定しない場合、すべてのポートのヘルスステータスが返されます。	80
ListenerProtocol	string	任意	SLB インスタンスが使用するフロントエンドプロトコル。	http
RegionId	string	任意	SLB インスタンスのリージョン ID。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	365F4154-92F6-4AE4-92F8-7FF******
BackendServers	object
BackendServer	array<object>	バックエンドサーバー。
	object	バックエンドサーバー。
Protocol	string	SLB インスタンスが使用するフロントエンドプロトコル。	http
ServerHealthStatus	string	バックエンドサーバーのヘルスステータス。有効な値： normal：バックエンドサーバーは正常です。 abnormal：バックエンドサーバーは異常です。 unavailable：ヘルスチェックが完了していません。	abnormal
ListenerPort	integer	SLB インスタンスが使用するフロントエンドポート。	80
ServerIp	string	バックエンドサーバーの IP アドレス。	192.XX.XX.11
Port	integer	SLB インスタンスが使用するバックエンドポート。	80
ServerId	string	バックエンドサーバーの ID。	i-bp1h5u3fv54ytf***

例

成功レスポンス

JSONJSON

{
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF******",
  "BackendServers": {
    "BackendServer": [
      {
        "Protocol": "http",
        "ServerHealthStatus": "abnormal",
        "ListenerPort": 80,
        "ServerIp": "192.XX.XX.11",
        "Port": 80,
        "ServerId": "i-bp1h5u3fv54ytf***"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	TooManyListeners	More than 1 listener is found, please be more specified.
400	LocationServiceTimeout	Location service connection timeout. Please try again later.
400	SystemBusy	The system is busy.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。