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

Gateway Load Balancer (GWLB) のリスナーのヘルスチェックステータスを照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gwlb:GetListenerHealthStatus

get

*LoadBalancer

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

*Listener

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ListenerId	string	必須	リスナー ID。	lsn-7sixpvm5fc3v0b****
NextToken	string	任意	次のリクエストで結果の新しいページを取得するために使用されるページネーショントークン。有効な値： NextToken が空の場合、次のページはありません。 NextToken の値が返された場合、その値は次のクエリに使用されるトークンを示します。	4f1d7cc9f51e18904e8a063603a6b0c3d03bc69f78734254e0b5e8707e68****
MaxResults	integer	任意	1 ページあたりのエントリ数。有効な値：1～1000。デフォルト値：20。	20
Skip	integer	任意	呼び出しでスキップするエントリ数。	10
Filter	array<object>	任意	フィルター条件。最大 20 個のフィルター条件を指定できます。
	object	任意	フィルター条件。
Name	string	任意	フィルター条件名。1 つ以上のフィルター条件名でフィルターできます。URL は次の要件を満たす必要があります： Status：ヘルスステータス。 ReasonCode：サーバーが異常である原因。 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：GWLB インスタンスが指定された期間内にバックエンドサーバーに接続できませんでした。 CONNECT_FAILED：GWLB インスタンスがバックエンドサーバーに接続できませんでした。 RECV_RESPONSE_TIMEOUT：GWLB インスタンスが指定された期間内にバックエンドサーバーから応答を受信できませんでした。 CONNECT_INTERRUPT：ヘルスチェックとバックエンドサーバー間の接続が中断されました。 HTTP_CODE_NOT_MATCH：バックエンドサーバーからの HTTP ステータスコードが期待されるものではありません。 HTTP_INVALID_HEADER：バックエンドサーバーからの応答のフォーマットが無効です。	CONNECT_TIMEOUT
ServerId	string	バックエンドサーバー ID。	i-2ze4rnh8yj9kif3z****
ServerIp	string	サーバーの IP アドレス。	192.168.0.XXX
Status	string	バックエンドサーバーのヘルスステータス。有効な値： Initial：GWLB インスタンスにヘルスチェックが設定されていますが、データが見つかりません。 Unhealthy：バックエンドサーバーが連続してヘルスチェックに失敗しました。 Unused：バックエンドサーバーは使用されていません。 Unavailable：ヘルスチェックが無効になっています。 Healthy：バックエンドサーバーは正常です。	Healthy
MaxResults	integer	1 ページあたりのエントリ数。有効な値：1～1000。デフォルト値：20。	20
NextToken	string	ページネーショントークン。次のリクエストで結果の新しいページを取得するために使用できます。有効な値： NextToken が空の場合、次のページはありません。 NextToken の値が返された場合、その値は次のクエリに使用されるトークンを示します。	U12WEI6Ro2ol3wA54rBNSwdC5+lYy6q5SjIQEvc1wz5mjZxV+YjsHRdXV8XauY1BpOQIvwX63E0en54H3D****
RequestId	string	リクエスト ID。	0ED4F222-36A0-5470-8A9A-AAB4E96BAC1A
TotalCount	integer	返されたエントリの総数。	31

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ
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.

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

変更履歴

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