ALB リスナーの GetListenerAttribute API リファレンス - ALB

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

今すぐお試しください

この 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>	リスナーに関連付けられている ACL の ID。
	object	リスナーに関連付けられている ACL の構造。
AclId	string	リスナーに関連付けられている ACL の ID。	acl-doc****
Status	string	ACL がリスナーに関連付けられているかどうかを示します。有効な値： Associating Associated Dissociating	Associating
AclType	string	ACL のタイプ。有効な値： White：ホワイトリスト。ネットワーク ACL 内の IP アドレスまたは CIDR ブロックからのリクエストのみが転送されます。ホワイトリストは、特定の IP アドレスのみにアプリケーションへのアクセスを許可するシナリオに適用されます。ホワイトリストが適切に設定されていない場合、サービスに悪影響が及ぶ可能性があります。リスナーにホワイトリストが設定されている場合、ホワイトリストに登録されている IP アドレスからのリクエストのみがリスナーによって転送されます。ホワイトリストを有効にしても、IP アドレスをホワイトリストに追加しない場合、リスナーはすべてのリクエストを転送します。 Black：ブラックリスト。ネットワーク ACL 内の IP アドレスまたは CIDR ブロックからのリクエストは拒否されます。ブラックリストは、特定の IP アドレスまたは CIDR ブロックからアプリケーションへのアクセスを拒否するシナリオに適しています。リスナーにブラックリストが設定されていても、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 アクションの設定。このパラメーターは、Type が ForwardGroup に設定されている場合に返され、有効になります。
ServerGroupTuples	array<object>	リクエストの転送先となるサーバーグループ。
	object	リクエストの転送先となるサーバーグループ。
ServerGroupId	string	リクエストの転送先となるサーバーグループの ID。	sgp-i5qt20******
Type	string	アクションのタイプ。 ForwardGroup が返された場合、リクエストは複数の vServer グループに転送されます。	ForwardGroup
GzipEnabled	boolean	GZIP 圧縮を有効にして特定の種類のファイルを圧縮するかどうかを示します。有効な値： true false	true
Http2Enabled	boolean	HTTP/2 が有効になっているかどうかを示します。有効な値： true false 説明このパラメーターは、HTTPS リスナーを作成する場合にのみ使用できます。	true
IdleTimeout	integer	アイドル接続のタイムアウト期間。単位：秒。指定されたタイムアウト期間内にリクエストが受信されない場合、Application Load Balancer (ALB) は現在の接続を閉じます。リクエストを受信すると、ALB は新しい接続を確立します。	2
ListenerDescription	string	リスナーの名前。	HTTP_80
ListenerId	string	リスナーの ID。	lsn-o4u54y73wq7b******
ListenerPort	integer	ALB インスタンスが使用するフロントエンドポート。	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 の設定。Xtrace は ALB に送信されたリクエストを記録するために使用されます。
TracingEnabled	boolean	Xtrace が有効になっているかどうかを示します。有効な値： true false 説明このパラメーターは、AccessLogEnabled パラメーターが true に設定されている場合にのみ true に設定できます。	true
TracingSample	integer	Xtrace のサンプリングレート。有効な値：1～10000。説明 TracingEnabled が true に設定されている場合、このパラメーターは有効です。	100
TracingType	string	Xtrace のタイプ。サポートされている Xtrace タイプ：Zipkin。説明 TracingEnabled が true に設定されている場合、このパラメーターは有効です。	Zipkin
QuicConfig	object	リスナーが QUIC リスナーに関連付けられている場合の設定情報。
QuicListenerId	string	QUIC リスナーの ID。このパラメーターは、QuicUpgradeEnabled が true に設定されている場合に返されます。HTTPS リスナーのみがこのパラメーターをサポートします。説明 HTTPS リスナーと QUIC リスナーを同じ ALB インスタンスに関連付ける必要があります。さらに、QUIC リスナーが他のリスナーに一度も関連付けられていないことを確認してください。	lsn-ek6ad66t****
QuicUpgradeEnabled	boolean	QUIC アップグレードが有効になっているかどうかを示します。有効な値： true false 説明 HTTPS リスナーのみがこのパラメーターをサポートします。	true
RequestId	string	リクエスト ID。	365F4154-92F6-4AE4-92F8-7FF******
RequestTimeout	integer	リクエストのタイムアウト期間。単位：秒。指定されたタイムアウト期間内にバックエンドサーバーから応答がない場合、ALB はクライアントに `HTTP 504` エラーコードを返します。	34
SecurityPolicyId	string	セキュリティポリシー。説明このパラメーターは、HTTPS リスナーを作成する場合にのみ使用できます。	tls_cipher_policy_1_1
XForwardedForConfig	object	XForwarded ヘッダーの設定。
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
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 に設定すると、ALB はリクエストがバックエンドサーバーに送信される前に、リクエスト内の既存の `X-Forwarded-For` ヘッダーに最後のホップの IP アドレスを追加します。このパラメーターを remove に設定すると、ALB はリクエストがバックエンドサーバーに送信される前に、リクエストが `X-Forwarded-For` ヘッダーを保持しているかどうかに関わらず、リクエスト内の `X-Forwarded-For` ヘッダーを削除します。このパラメーターは、HTTP および HTTPS リスナーでのみ使用できます。	append
XForwardedForProtoEnabled	boolean	`X-Forwarded-Proto` ヘッダーを使用してリスニングプロトコルを取得するかどうかを示します。有効な値： true false 説明このパラメーターは、HTTP、HTTPS、または QUIC リスナーを作成する場合にのみ使用できます。	true
XForwardedForSLBIdEnabled	boolean	`SLB-ID` ヘッダーを使用して CLB インスタンスの ID を取得するかどうかを示します。有効な値： true false 説明このパラメーターは、HTTP、HTTPS、または QUIC リスナーを作成する場合にのみ使用できます。	true
XForwardedForSLBPortEnabled	boolean	`X-Forwarded-Port` ヘッダーを使用して ALB インスタンスのリスニングポートを取得するかどうかを示します。有効な値： true false 説明このパラメーターは、HTTP、HTTPS、または QUIC リスナーを作成する場合にのみ使用できます。	true
XForwardedForClientSourceIpsEnabled	boolean	`X-Forwarded-Client-Ip` ヘッダーを使用して ALB インスタンスの送信元ポートを取得するかどうかを示します。有効な値： true false 説明このパラメーターは、HTTP、HTTPS、または QUIC リスナーを作成する場合にのみ使用できます。	false
XForwardedForClientSourceIpsTrusted	string	信頼できるプロキシ IP アドレス。 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 文字で、`acs:` または `aliyun` で始めることはできません。`http://` または `https://` を含めることはできません。	env
Value	string	タグ値。タグ値は最大 128 文字で、`acs:` または `aliyun` で始めることはできません。`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.

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

変更履歴

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