GetListenerAttribute - - 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:GetListenerAttribute

get

*LoadBalancer

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

*Listener

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

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
ListenerId	string	必須	リスナー ID。	lsn-brx2y3hqdinciz****

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	返されるデータ。
ListenerDescription	string	リスナーのカスタム記述。記述は 2 ～ 256 文字でなければなりません。中国語、文字、数字、カンマ (,)、ピリオド (.)、セミコロン (;)、スラッシュ (/)、アットマーク (@)、アンダースコア (_)、ハイフン (-) を使用できます。	listener_description
ListenerId	string	リスナー ID。	lsn-3kbj3587mqhm3p****
ListenerStatus	string	リスナーのステータス。有効な値： Provisioning: リスナーを作成中です。 Running: リスナーは実行中です。 Configuring: リスナーを構成中です。 Deleting: リスナーを削除中です。	Provisioning
LoadBalancerId	string	Gateway Load Balancer インスタンスの ID。	gwlb-te609d6696632f76****
RegionId	string	Gateway Load Balancer インスタンスがデプロイされているリージョンの ID。	cn-hangzhou
RequestId	string	リクエスト ID。	75CC3312-7757-5EE1-90D8-49CEA66608AE
ServerGroupId	string	サーバーグループ ID。	sgp-sp8d2r6y7t0xtl****
TcpIdleTimeout	integer	アイドル状態の TCP 接続のタイムアウト期間。	350
Tags	array<object>	タグのリスト。
	object	タグ。
Key	string	タグキー。タグキーは空の文字列にすることはできません。タグキーは最大 128 文字で、`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。	testKey
Value	string	タグ値。タグ値は最大 256 文字で、`http://` または `https://` を含めることはできません。	testValue

例

成功レスポンス

JSONJSON

{
  "ListenerDescription": "listener_description",
  "ListenerId": "lsn-3kbj3587mqhm3p****",
  "ListenerStatus": "Provisioning",
  "LoadBalancerId": "gwlb-te609d6696632f76****",
  "RegionId": "cn-hangzhou",
  "RequestId": "75CC3312-7757-5EE1-90D8-49CEA66608AE",
  "ServerGroupId": "sgp-sp8d2r6y7t0xtl****",
  "TcpIdleTimeout": 350,
  "Tags": [
    {
      "Key": "testKey",
      "Value": "testValue"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	ResourceNotFound.Listener	The specified resource of %s is not found.

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

変更履歴

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