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: 選択したコントロールポリシーグループで設定された IP アドレスまたは CIDR ブロックからのリクエストのみが転送されます。ホワイトリストは、特定の IP アドレスからのみアプリケーションへのアクセスを許可したいシナリオに適しています。ホワイトリストを有効にすると、一定のリスクが生じます。ホワイトリストを有効にすると、ホワイトリスト内の IP アドレスのみがロードバランサーリスナーにアクセスできます。ホワイトリストが有効になっているにもかかわらず、コントロールポリシーグループに IP アドレスが追加されていない場合、ロードバランサーリスナーはすべてのリクエストを転送します。 Black: 選択したコントロールポリシーグループで設定された IP アドレスまたは CIDR ブロックからのすべてのリクエストがブロックされます。ブラックリストは、特定の IP アドレスからのアクセスをブロックしたいシナリオに適しています。ブラックリストが有効になっているにもかかわらず、コントロールポリシーグループに IP アドレスが追加されていない場合、ロードバランサーリスナーはすべてのリクエストを転送します。	White
Certificates	array<object>	証明書のリスト。
	object	証明書の構造。
CertificateId	string	証明書の ID。サーバー証明書のみがサポートされています。	123157*******
CaCertificates	array<object>	CA 証明書のリスト。
	object
CertificateId	string	CA 証明書の ID。	139a00*****
Status	string	証明書のステータス。	Associated
IsDefault	boolean	証明書がデフォルト証明書であるかどうかを示します。有効な値: true: はい。 false: いいえ。	true
CaEnabled	boolean	相互認証が有効かどうかを示します。有効な値: true: はい。 false: いいえ。	false
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	ロードバランサーインスタンスの 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
XForwardedForConfig	object	XForward のフィールド設定。
XForwardedForClientCertClientVerifyAlias	string	カスタムヘッダー名。この値は XForwardedForClientCertClientVerifyEnabled が true に設定されている場合にのみ効果が得られます。値の長さは 1～40 文字で、小文字の a～z、ハイフン (-)、アンダースコア (_)、数字を使用できます。説明このパラメーターは HTTPS リスナーのみでサポートされます。	test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabled	boolean	`X-Forwarded-Clientcert-clientverify` ヘッダーフィールドを使用して、ロードバランサーインスタンスにアクセスするクライアント証明書の検証結果を取得するかどうかを示します。有効な値: true: はい。 false: いいえ。説明このパラメーターは HTTPS リスナーのみでサポートされます。	true
XForwardedForClientCertFingerprintAlias	string	カスタムヘッダー名。この値は XForwardedForClientCertFingerprintEnabled が true に設定されている場合にのみ効果が得られます。値の長さは 1～40 文字で、小文字の a～z、ハイフン (-)、アンダースコア (_)、数字を使用できます。説明このパラメーターは HTTPS リスナーのみでサポートされます。	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	`X-Forwarded-Clientcert-fingerprint` ヘッダーフィールドを使用して、ロードバランサーインスタンスにアクセスするクライアント証明書の指紋を取得するかどうかを示します。有効な値: true: はい。 false: いいえ。説明このパラメーターは HTTPS リスナーのみでサポートされます。	true
XForwardedForClientCertIssuerDNAlias	string	カスタムヘッダー名。この値は XForwardedForClientCertIssuerDNEnabled が true に設定されている場合にのみ効果が得られます。値の長さは 1～40 文字で、小文字の a～z、ハイフン (-)、アンダースコア (_)、数字を使用できます。説明このパラメーターは HTTPS リスナーのみでサポートされます。	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	`X-Forwarded-Clientcert-issuerdn` ヘッダーフィールドを使用して、ロードバランサーインスタンスにアクセスするクライアント証明書の発行者情報を取得するかどうかを示します。有効な値: true: はい。 false: いいえ。説明このパラメーターは HTTPS リスナーのみでサポートされます。	true
XForwardedForClientCertSubjectDNAlias	string	カスタムヘッダー名。この値は XForwardedForClientCertSubjectDNEnabled が true に設定されている場合にのみ効果が得られます。値の長さは 1～40 文字で、小文字の a～z、ハイフン (-)、アンダースコア (_)、数字を使用できます。説明このパラメーターは HTTPS リスナーのみでサポートされます。	test_subject-dn-alias_123456
XForwardedForClientCertSubjectDNEnabled	boolean	`X-Forwarded-Clientcert-subjectdn` ヘッダーフィールドを使用して、ロードバランサーインスタンスにアクセスするクライアント証明書のオーナー情報を取得するかどうかを示します。有効な値: true: はい。 false: いいえ。説明このパラメーターは HTTPS リスナーのみでサポートされます。	true
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
XForwardedForProcessingMode	string	`X-Forwarded-For` ヘッダーフィールドの処理モード。この値は XForwardedForEnabled が true に設定されている場合にのみ効果が得られます。有効な値: append (デフォルト): 追加。 remove: 削除。説明 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
XForwardedForClientSourceIpsEnabled	boolean	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
XForwardedForHostEnabled	boolean	`X-Forwarded-Host` ヘッダーフィールドを使用して、ロードバランサーインスタンスにアクセスするクライアントのドメイン名を取得するかどうかを示します。有効な値: true: はい。 false (デフォルト): いいえ。説明このパラメーターは HTTP、HTTPS、および QUIC リスナーでサポートされます。	false
Tags	array<object>	タグ。
	object	タグの構造。
Key	string	タグキー。タグキーの長さは最大 128 文字で、`aliyun` または `acs:` で始めることはできません。また、`http://` または `https://` を含めることはできません。	env
Value	string	タグ値。タグ値の長さは最大 128 文字で、`aliyun` または `acs:` で始めることはできません。また、`http://` または `https://` を含めることはできません。	product

例

成功レスポンス

JSONJSON

{
  "AclConfig": {
    "AclRelations": [
      {
        "AclId": "acl-doc****",
        "Status": "Associating"
      }
    ],
    "AclType": "White"
  },
  "Certificates": [
    {
      "CertificateId": "123157*******"
    }
  ],
  "CaCertificates": [
    {
      "CertificateId": "139a00*****",
      "Status": "Associated",
      "IsDefault": true
    }
  ],
  "CaEnabled": false,
  "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",
  "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,
    "XForwardedForClientSrcPortEnabled": true,
    "XForwardedForEnabled": true,
    "XForwardedForProcessingMode": "append",
    "XForwardedForProtoEnabled": true,
    "XForwardedForSLBIdEnabled": true,
    "XForwardedForSLBPortEnabled": true,
    "XForwardedForClientSourceIpsEnabled": false,
    "XForwardedForClientSourceIpsTrusted": "10.1.1.0/24",
    "XForwardedForHostEnabled": false
  },
  "Tags": [
    {
      "Key": "env",
      "Value": "product"
    }
  ]
}

エラーコード

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

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

変更履歴

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