ALB リスナーの GetListenerAttribute API リファレンス - ALB - Alibaba Cloud - Server Load Balancer

リスナーの詳細を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

alb:GetListenerAttribute

get

*LoadBalancer。

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

acs:ResourceTag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ListenerId	string	必須	リスナーの ID。	lsn-o4u54y73wq7b******

レスポンスフィールド

フィールド	型	説明	例
	object	リスナーの詳細情報のリスト。
AclConfig	object	ACL 構成の構造。
AclRelations	array<object>	リスナーに関連付けられたアクセスコントロールポリシーの ID のリスト。
	object	リスナーに関連付けられたアクセスコントロールポリシーのリストの構造。
AclId	string	リスナーに関連付けられたアクセスコントロールポリシーの ID のリスト。	acl-doc****
Status	string	ACL とリスナー間の関連付けステータスのリスト。有効な値: Associating: ACL を関連付けています。 Associated: ACL は関連付けられています。 Dissociating: ACL の関連付けを解除しています。	Associating
AclType	string	アクセスコントロールタイプ。有効な値: White: 選択した ACL に設定された IP アドレスまたは CIDR ブロックからのリクエストのみが転送されます。ホワイトリストは、アプリケーションが特定の IP アドレスからのアクセスのみを許可するシナリオに適用されます。ホワイトリストの設定にはビジネスリスクが伴います。ホワイトリストを設定すると、ホワイトリスト内の IP アドレスからのリクエストのみが負荷分散リスナーにアクセスできます。ホワイトリストアクセスを有効にしても ACL に IP アドレスを追加しない場合、負荷分散リスナーはすべてのリクエストを転送します。 Black: 選択した ACL に設定された IP アドレスまたは CIDR ブロックからのリクエストは転送されません。ブラックリストは、アプリケーションが特定の IP アドレスからのアクセスをブロックするシナリオに適用されます。ブラックリストアクセスを有効にしても ACL に IP アドレスを追加しない場合、負荷分散リスナーはすべてのリクエストを転送します。 (ロード) (リスト)	White
CaCertificates	array<object>	CA 証明書のリスト。
	object
CertificateId	string	CA 証明書の ID。	139a00*****
IsDefault	boolean	証明書がデフォルト証明書であるかどうかを示します。有効な値: true: はい。 false: いいえ。	true
Status	string	証明書のステータス。	Associated
CaEnabled	boolean	相互認証が有効かどうかを示します。有効な値: true: はい。 false: いいえ。	false
Certificates	array<object>	証明書のリスト。
	object	証明書の構造。
CertificateId	string	証明書の ID。サーバー証明書のみがサポートされています。	123157*******
DefaultActions	array<object>	デフォルトルール操作のリスト。
	array<object>	デフォルトルール操作の構造。
ForwardGroupConfig	object	転送操作の構成。このパラメーターは、操作タイプが ForwardGroup の場合にのみ効果を発揮します。
ServerGroupTuples	array<object>	送信先サーバーグループ。
	object	送信先サーバーグループ。
ServerGroupId	string	送信先サーバーグループの ID。	sgp-i5qt20******
Type	string	操作タイプ。有効な値: ForwardGroup。これは、リクエストが複数のサーバーグループに転送されることを示します。	ForwardGroup
GzipEnabled	boolean	特定のファイルタイプを圧縮するために Gzip 圧縮が有効かどうかを示します。有効な値: true: はい。 false: いいえ。	true
Http2Enabled	boolean	HTTP/2 が有効かどうかを示します。有効な値: true: はい。 false: いいえ。説明このパラメーターは、HTTPS リスナーでのみサポートされています。 (リスト)	true
IdleTimeout	integer	アイドル接続タイムアウト期間を示します。単位: 秒。タイムアウト期間内にリクエストが受信されない場合、ロードバランサーは一時的に現在の接続を閉じ、次のリクエストが到着したときに新しい接続を確立します。	2
ListenerDescription	string	リスナーのカスタム名 (リスト)。	HTTP_80
ListenerId	string	リスナーの ID (リスト)。	lsn-o4u54y73wq7b******
ListenerPort	integer	ロードバランサーが使用するフロントエンドポート。	80
ListenerProtocol	string	リスナープロトコル (リスト)。有効な値: HTTP、HTTPS、QUIC。	HTTP
ListenerStatus	string	リスナーの現在のステータス (リスト)。有効な値: Provisioning: リスナーはプロビジョニング中です。 Running: リスナーは実行中です。 Configuring: リスナーを設定しています。 Stopped: リスナーは停止しています。	Running
LoadBalancerId	string	ALB インスタンスの ID。	alb-bd6oylbckp6k9x****
LogConfig	object	ログ構成情報。
AccessLogRecordCustomizedHeadersEnabled	boolean	カスタムヘッダーフィールドがアクセスログに含まれるかどうかを示します。有効な値: true: はい。 false: いいえ。	true
AccessLogTracingConfig	object	アクセスログの Xtrace 構成情報。
TracingEnabled	boolean	Xtrace 特徴のステータス。有効な値: true: はい。 false: いいえ。説明このパラメーターは、インスタンスのアクセスログ特徴 (AccessLogEnabled) が有効な場合にのみ true にセットできます。	true
TracingSample	integer	Xtrace のサンプリングレート。有効な値: 1 ~ 10000。説明このパラメーターは、TracingEnabled が true にセットされている場合にのみ効果を発揮します。	100
TracingType	string	Xtrace のタイプ。有効な値: Zipkin。説明このパラメーターは、TracingEnabled が true にセットされている場合にのみ効果を発揮します。	Zipkin
QuicConfig	object	QUIC リスナーを関連付けるための構成情報 (リスト)。
QuicListenerId	string	関連付ける QUIC リスナーの ID。このパラメーターは、QuicUpgradeEnabled が true にセットされている場合に必須です。このパラメーターは、HTTPS リスナーに対してのみ効果を発揮します。 (リスト) 説明元のリスナーと関連付けられた QUIC リスナーは同じ ALB インスタンスに属している必要があり、かつ QUIC リスナーは以前に関連付けられていない必要があります。	lsn-ek6ad66t****
QuicUpgradeEnabled	boolean	QUIC スペックアップが有効かどうかを示します。有効な値: true: はい。 false: いいえ。説明このパラメーターは、HTTPS リスナーに対してのみ効果を発揮します。 (リスト)	true
RequestId	string	リクエストの ID。	365F4154-92F6-4AE4-92F8-7FF******
RequestTimeout	integer	リクエストタイムアウト期間を示します。単位: 秒。バックエンドサーバーがタイムアウト期間内に応答を送信しない場合、ロードバランサーは待機を停止し、クライアントに HTTP 504 エラーコードを返します。	34
SecurityPolicyId	string	セキュリティポリシー。説明このパラメーターは HTTPS リスナーでのみサポートされています。	tls_cipher_policy_1_1
Tags	array<object>	タグ。
	object	タグの構造。
Key	string	タグキー。長さは最大 128 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。	env
Value	string	タグ値。長さは最大 128 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。	product
XForwardedForConfig	object	X-Forwarded-For フィールド構成。
XForwardedForClientCertClientVerifyAlias	string	カスタムヘッダー名。このパラメーターは、XForwardedForClientCertClientVerifyEnabled が true にセットされている場合にのみ効果があります。名前は 1～40 文字の長さで、小文字、ハイフン (-)、アンダースコア (_)、数字を含めることができます。説明このパラメーターは HTTPS リスナーでのみサポートされています。	test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabled	boolean	`X-Forwarded-Clientcert-clientverify` ヘッダーフィールドを使用して、ロードバランサーインスタンスにアクセスするクライアント証明書の検証結果を取得するかどうかを指定します。有効な値: true: はい。 false: いいえ。説明このパラメーターは HTTPS リスナーでのみサポートされています。	true
XForwardedForClientCertFingerprintAlias	string	カスタムヘッダー名。このパラメーターは、XForwardedForClientCertFingerprintEnabled が true にセットされている場合にのみ効果があります。名前は 1～40 文字の長さで、小文字、ハイフン (-)、アンダースコア (_)、数字を含めることができます。説明このパラメーターは HTTPS リスナーでのみサポートされています。	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	`X-Forwarded-Clientcert-fingerprint` ヘッダーフィールドを使用して、ロードバランサーインスタンスにアクセスするクライアント証明書の指紋を取得するかどうかを指定します。有効な値: true: はい。 false: いいえ。説明このパラメーターは HTTPS リスナーでのみサポートされています。	true
XForwardedForClientCertIssuerDNAlias	string	カスタムヘッダー名。このパラメーターは、XForwardedForClientCertIssuerDNEnabled が true にセットされている場合にのみ効果があります。名前は 1～40 文字の長さで、小文字、ハイフン (-)、アンダースコア (_)、数字を含めることができます。説明このパラメーターは HTTPS リスナーでのみサポートされています。	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	`X-Forwarded-Clientcert-issuerdn` ヘッダーフィールドを使用して、ロードバランサーインスタンスにアクセスするクライアント証明書の発行者情報を取得するかどうかを指定します。有効な値: true: はい。 false: いいえ。説明このパラメーターは HTTPS リスナーでのみサポートされています。	true
XForwardedForClientCertSubjectDNAlias	string	カスタムヘッダー名。このパラメーターは、XForwardedForClientCertSubjectDNEnabled が true にセットされている場合にのみ効果があります。名前は 1～40 文字の長さで、小文字、ハイフン (-)、アンダースコア (_)、数字を含めることができます。説明このパラメーターは HTTPS リスナーでのみサポートされています。	test_subject-dn-alias_123456
XForwardedForClientCertSubjectDNEnabled	boolean	`X-Forwarded-Clientcert-subjectdn` ヘッダーフィールドを使用して、ロードバランサーインスタンスにアクセスするクライアント証明書の主題情報を取得するかどうかを指定します。有効な値: true: はい。 false: いいえ。説明このパラメーターは HTTPS リスナーでのみサポートされています。	true
XForwardedForClientSourceIpsEnabled	boolean	Application Load Balancer (ALB) が `X-Forwarded-For` ヘッダーフィールドから実際のクライアント IP アドレスを取得することを許可するかどうかを指定します。有効な値: true: はい。 false: いいえ。説明このパラメーターは HTTP リスナーおよび HTTPS リスナーでサポートされています。	false
XForwardedForClientSourceIpsTrusted	string	信頼されたプロキシ IP アドレス。 Application Load Balancer (ALB) は `X-Forwarded-For` ヘッダーフィールドを後ろから前へ走査し、信頼された IP アドレスリストにない最初の IP アドレスを実際のクライアント IP アドレスとして選択します。この IP アドレスは、ソース IP アドレスベースのレート制限に使用されます。	10.1.1.0/24
XForwardedForClientSrcPortEnabled	boolean	`X-Forwarded-Client-Port` ヘッダーフィールドを使用して、ロードバランサーインスタンスにアクセスするクライアントのポートを取得するかどうかを指定します。有効な値: true: はい。 false: いいえ。説明このパラメーターは HTTP リスナーおよび HTTPS リスナーでサポートされています。	true
XForwardedForEnabled	boolean	`X-Forwarded-For` ヘッダーフィールドを使用して、クライアントの実際の IP アドレスを取得するかどうかを指定します。有効な値: true (デフォルト): はい。 false: いいえ。説明このパラメーターを true にセットすると、XForwardedForProcessingMode のデフォルト値は append になり、remove に変更できます。このパラメーターを false にセットすると、リクエストがバックエンドサーバーに転送される前に、`X-Forwarded-For` ヘッダーフィールドは追加処理なしで保持されます。このパラメーターは HTTP リスナーおよび HTTPS リスナーでサポートされています。	true
XForwardedForHostEnabled	boolean	`X-Forwarded-Host` ヘッダーフィールドを使用して、ロードバランサーインスタンスにアクセスするクライアントのドメイン名を取得するかどうかを指定します。有効な値: true: はい。 false (デフォルト): いいえ。説明このパラメーターは HTTP、HTTPS、および QUIC リスナーでサポートされています。	false
XForwardedForProcessingMode	string	`X-Forwarded-For` ヘッダーフィールドの処理モード。このパラメーターは、XForwardedForEnabled が true にセットされている場合にのみ効果があります。有効な値: append (デフォルト): リクエストがバックエンドサーバーに転送される前に、最後のホップの IP アドレスを `X-Forwarded-For` ヘッダーフィールドに追加します。 remove: リクエストに `X-Forwarded-For` ヘッダーフィールドが含まれているかどうかに関係なく、リクエストがバックエンドサーバーに転送される前に `X-Forwarded-For` ヘッダーフィールドを削除します。説明このパラメーターを append にセットすると、リクエストがバックエンドサーバーに転送される前に、最後のホップの IP アドレスが `X-Forwarded-For` ヘッダーフィールドに追加されます。このパラメーターを remove にセットすると、リクエストに `X-Forwarded-For` ヘッダーフィールドが含まれているかどうかに関係なく、リクエストがバックエンドサーバーに転送される前に `X-Forwarded-For` ヘッダーフィールドが削除されます。このパラメーターは HTTP リスナーおよび HTTPS リスナーでサポートされています。	append
XForwardedForProtoEnabled	boolean	`X-Forwarded-Proto` ヘッダーフィールドを使用して、ロードバランサーインスタンスのリスナープロトコルを取得するかどうかを指定します。有効な値: true: はい。 false: いいえ。説明このパラメーターは HTTP、HTTPS、および QUIC リスナーでサポートされています。	true
XForwardedForSLBIdEnabled	boolean	`SLB-ID` ヘッダーフィールドを使用して、ロードバランサーインスタンス ID を取得するかどうかを指定します。有効な値: true: はい。 false: いいえ。説明このパラメーターは HTTP、HTTPS、および QUIC リスナーでサポートされています。	true
XForwardedForSLBPortEnabled	boolean	`X-Forwarded-Port` ヘッダーフィールドを使用して、ロードバランサーインスタンスのリスナーポートを取得するかどうかを指定します。有効な値: true: はい。 false: いいえ。説明このパラメーターは HTTP、HTTPS、および QUIC リスナーでサポートされています。	true

例

成功レスポンス

JSONJSON

{
  "AclConfig": {
    "AclRelations": [
      {
        "AclId": "acl-doc****",
        "Status": "Associating"
      }
    ],
    "AclType": "White"
  },
  "CaCertificates": [
    {
      "CertificateId": "139a00*****",
      "IsDefault": true,
      "Status": "Associated"
    }
  ],
  "CaEnabled": false,
  "Certificates": [
    {
      "CertificateId": "123157*******"
    }
  ],
  "DefaultActions": [
    {
      "ForwardGroupConfig": {
        "ServerGroupTuples": [
          {
            "ServerGroupId": "sgp-i5qt20******"
          }
        ]
      },
      "Type": "ForwardGroup"
    }
  ],
  "GzipEnabled": true,
  "Http2Enabled": true,
  "IdleTimeout": 2,
  "ListenerDescription": "HTTP_80",
  "ListenerId": "lsn-o4u54y73wq7b******",
  "ListenerPort": 80,
  "ListenerProtocol": "HTTP",
  "ListenerStatus": "Running",
  "LoadBalancerId": "alb-bd6oylbckp6k9x****",
  "LogConfig": {
    "AccessLogRecordCustomizedHeadersEnabled": true,
    "AccessLogTracingConfig": {
      "TracingEnabled": true,
      "TracingSample": 100,
      "TracingType": "Zipkin"
    }
  },
  "QuicConfig": {
    "QuicListenerId": "lsn-ek6ad66t****",
    "QuicUpgradeEnabled": true
  },
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF******",
  "RequestTimeout": 34,
  "SecurityPolicyId": "tls_cipher_policy_1_1",
  "Tags": [
    {
      "Key": "env",
      "Value": "product"
    }
  ],
  "XForwardedForConfig": {
    "XForwardedForClientCertClientVerifyAlias": "test_client-verify-alias_123456",
    "XForwardedForClientCertClientVerifyEnabled": true,
    "XForwardedForClientCertFingerprintAlias": "test_finger-print-alias_123456",
    "XForwardedForClientCertFingerprintEnabled": true,
    "XForwardedForClientCertIssuerDNAlias": "test_issue-dn-alias_123456",
    "XForwardedForClientCertIssuerDNEnabled": true,
    "XForwardedForClientCertSubjectDNAlias": "test_subject-dn-alias_123456",
    "XForwardedForClientCertSubjectDNEnabled": true,
    "XForwardedForClientSourceIpsEnabled": false,
    "XForwardedForClientSourceIpsTrusted": "10.1.1.0/24",
    "XForwardedForClientSrcPortEnabled": true,
    "XForwardedForEnabled": true,
    "XForwardedForHostEnabled": false,
    "XForwardedForProcessingMode": "append",
    "XForwardedForProtoEnabled": true,
    "XForwardedForSLBIdEnabled": true,
    "XForwardedForSLBPortEnabled": true
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	Forbidden.LoadBalancer	Authentication is failed for %s.	負荷分散操作の認証が失敗しました。
404	ResourceNotFound.Listener	The specified resource %s is not found.	リスナーが存在しません。

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

変更履歴

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