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

リスナーを作成します。

操作説明

注意事項

CreateListener は非同期操作です。この操作を呼び出すと、リクエスト ID が返されますが、操作はバックグラウンドで実行され続けます。GetListenerAttribute 操作を呼び出して、HTTP、HTTPS、または QUIC リスナーのステータスをクエリできます。

HTTP、HTTPS、または QUIC リスナーが Provisioning 状態の場合、リスナーが作成中であることを示します。
HTTP、HTTPS、または QUIC リスナーが Running 状態の場合、リスナーが正常に作成されたことを示します。

今すぐお試しください

この 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:CreateListener

create

*LoadBalancer

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

*SecurityPolicy

acs:alb:{#regionId}:{#accountId}:securitypolicy/{#securitypolicyId}

*ServerGroup

acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId}

alb:ListenerProtocol

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
LoadBalancerId	string	必須	ALB インスタンスの ID。	alb-n5qw04uq8vavfe****
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークンです。クライアントを使用して値を生成できますが、すべてのリクエストで一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを設定しない場合、システムは自動的に RequestId の値を ClientToken の値として使用します。RequestId は API リクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	任意	事前チェックのみを実行するかどうかを指定します。有効な値： true：リスナーを作成せずにリクエストを事前チェックします。システムは必須パラメーター、リクエスト構文、および制限を確認します。リクエストが事前チェックに失敗した場合、失敗の原因に基づいてエラーコードが返されます。リクエストが事前チェックに成功した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト)：API リクエストを送信します。リクエストが事前チェックに成功した場合、2xx HTTP ステータスコードが返され、システムはリスナーの作成に進みます。	false
ListenerProtocol	string	必須	リスナープロトコル。有効な値：HTTP、HTTPS、QUIC。	HTTP
ListenerPort	integer	必須	ALB インスタンスが使用するフロントエンドポート。有効な値：1～65535。	80
ListenerDescription	string	任意	リスナーの名前。説明は長さが 2～256 文字で、文字、数字、ハイフン (-)、スラッシュ (/)、ピリオド (.)、アンダースコア (_) を使用できます。正規表現がサポートされています。	HTTP_80
RequestTimeout	integer	任意	リクエストのタイムアウト期間。単位：秒。有効な値：1～180。デフォルト値：60。リクエストのタイムアウト期間内にバックエンドサーバーから応答がない場合、ALB はクライアントに `HTTP 504` エラーコードを送信します。	60
IdleTimeout	integer	任意	アイドル接続のタイムアウト期間。単位：秒。有効な値：1～60。デフォルト値：15。指定されたタイムアウト期間内にリクエストが受信されない場合、ALB は現在の接続を閉じます。新しいリクエストが受信されると、ALB は新しい接続を確立します。	3
GzipEnabled	boolean	任意	特定の種類のファイルを圧縮するために `Gzip` 圧縮を有効にするかどうかを指定します。有効な値： true (デフォルト)：Gzip 圧縮を有効にします。 false：Gzip 圧縮を無効にします。	true
Http2Enabled	boolean	任意	`HTTP/2` を有効にするかどうかを指定します。有効な値： true (デフォルト)：HTTP/2 を有効にします。 false：HTTP/2 を無効にします。説明 HTTPS リスナーのみがこのパラメーターをサポートします。	true
SecurityPolicyId	string	任意	セキュリティポリシーの ID。システムセキュリティポリシーとカスタムセキュリティポリシーがサポートされています。デフォルト値：tls_cipher_policy_1_0 (システムセキュリティポリシー)。説明 HTTPS リスナーのみがこのパラメーターをサポートします。	tls_cipher_policy_1_0
CaEnabled	boolean	任意	相互認証を有効にするかどうかを指定します。有効な値： true：相互認証を有効にします。 false (デフォルト)：相互認証を無効にします。	false
XForwardedForConfig	object	任意	X-Forwarded ヘッダーの構成。
XForwardedForClientCertClientVerifyAlias	string	任意	カスタムヘッダーの名前。このパラメーターは、XForwardedForClientCertClientVerifyEnabled が true に設定されている場合にのみ有効です。名前は 1～40 文字の長さで、小文字、ハイフン (-)、アンダースコア (_)、および数字を含めることができます。説明 HTTPS リスナーのみがこのパラメーターをサポートします。	test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabled	boolean	任意	`X-Forwarded-Clientcert-clientverify` ヘッダーを使用してクライアント証明書の検証結果を取得するかどうかを指定します。有効な値： true：X-Forwarded-Clientcert-clientverify ヘッダーを使用します。 false (デフォルト)：X-Forwarded-Clientcert-clientverify ヘッダーを使用しません。説明 HTTPS リスナーのみがこのパラメーターをサポートします。	true
XForwardedForClientCertFingerprintAlias	string	任意	カスタムヘッダーの名前。このパラメーターは、XForwardedForClientCertFingerprintEnabled が true に設定されている場合にのみ有効です。名前は 1～40 文字の長さで、小文字、ハイフン (-)、アンダースコア (_)、および数字を含めることができます。説明 HTTPS リスナーのみがこのパラメーターをサポートします。	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	任意	`X-Forwarded-Clientcert-fingerprint` ヘッダーを使用してクライアント証明書の指紋を取得するかどうかを指定します。有効な値： true：X-Forwarded-Clientcert-fingerprint ヘッダーを使用します。 false (デフォルト)：X-Forwarded-Clientcert-fingerprint ヘッダーを使用しません。説明 HTTPS リスナーのみがこのパラメーターをサポートします。	true
XForwardedForClientCertIssuerDNAlias	string	任意	カスタムヘッダーの名前。このパラメーターは、XForwardedForClientCertIssuerDNEnabled が true に設定されている場合にのみ有効です。名前は 1～40 文字の長さで、小文字、ハイフン (-)、アンダースコア (_)、および数字を含めることができます。説明 HTTPS リスナーのみがこのパラメーターをサポートします。	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	任意	`X-Forwarded-Clientcert-issuerdn` ヘッダーを使用して、クライアント証明書を発行した認証局に関する情報を取得するかどうかを指定します。有効な値： true：X-Forwarded-Clientcert-issuerdn ヘッダーを使用します。 false (デフォルト)：X-Forwarded-Clientcert-issuerdn ヘッダーを使用しません。説明 HTTPS リスナーのみがこのパラメーターをサポートします。	true
XForwardedForClientCertSubjectDNAlias	string	任意	カスタムヘッダーの名前。このパラメーターは、XForwardedForClientCertSubjectDNEnabled が true に設定されている場合にのみ有効です。名前は 1～40 文字の長さで、小文字、ハイフン (-)、アンダースコア (_)、および数字を含めることができます。説明 HTTPS リスナーのみがこのパラメーターをサポートします。	test_subject-dn-alias_123456
XForwardedForClientCertSubjectDNEnabled	boolean	任意	`X-Forwarded-Clientcert-subjectdn` ヘッダーを使用して、クライアント証明書のオーナーに関する情報を取得するかどうかを指定します。有効な値： true：X-Forwarded-Clientcert-subjectdn ヘッダーを使用します。 false (デフォルト)：X-Forwarded-Clientcert-subjectdn ヘッダーを使用しません。説明 HTTPS リスナーのみがこのパラメーターをサポートします。	true
XForwardedForClientSrcPortEnabled	boolean	任意	`X-Forwarded-Client-srcport` ヘッダーを使用してクライアントポートを取得するかどうかを指定します。有効な値： true：X-Forwarded-Client-srcport ヘッダーを使用します。 false (デフォルト)：X-Forwarded-Client-srcport ヘッダーを使用しません。説明 HTTP および HTTPS リスナーがこのパラメーターをサポートします。	true
XForwardedForEnabled	boolean	任意	`X-Forwarded-For` ヘッダーを使用してクライアント IP アドレスを取得するかどうかを指定します。有効な値： true (デフォルト) false 説明 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` ヘッダーを使用して ALB インスタンスのリスナープロトコルを取得するかどうかを指定します。有効な値： true：X-Forwarded-Proto ヘッダーを使用します。 false (デフォルト)：X-Forwarded-Proto ヘッダーを使用しません。説明 HTTP、HTTPS、および QUIC リスナーがこのパラメーターをサポートします。	false
XForwardedForSLBIdEnabled	boolean	任意	`SLB-ID` ヘッダーを使用して ALB インスタンスの ID を取得するかどうかを指定します。有効な値： true：SLB-ID ヘッダーを使用します。 false (デフォルト)：SLB-ID ヘッダーを使用しません。説明 HTTP、HTTPS、および QUIC リスナーがこのパラメーターをサポートします。	false
XForwardedForSLBPortEnabled	boolean	任意	`X-Forwarded-Port` ヘッダーを使用して ALB インスタンスのリスナーポートを取得するかどうかを指定します。有効な値： true：X-Forwarded-Port ヘッダーを使用します。 false (デフォルト)：X-Forwarded-Port ヘッダーを使用しません。説明 HTTP、HTTPS、および QUIC リスナーがこのパラメーターをサポートします。	false
XForwardedForClientSourceIpsEnabled	boolean	任意	ALB インスタンスが `X-Forwarded-For` ヘッダーからクライアント IP アドレスを取得することを許可するかどうかを指定します。有効な値： true false (デフォルト) 説明 HTTP および HTTPS リスナーがこのパラメーターをサポートします。	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
QuicConfig	object	任意	QUIC リスナーを選択し、ALB インスタンスに関連付けます。
QuicListenerId	string	任意	HTTPS リスナーに関連付ける QUIC リスナーの ID。HTTPS リスナーのみがこのパラメーターをサポートします。このパラメーターは、QuicUpgradeEnabled が true に設定されている場合に必須です。説明 HTTPS リスナーと QUIC リスナーは、同じ ALB インスタンスに追加する必要があります。QUIC リスナーが他のリスナーに関連付けられていないことを確認してください。	lsn-o4u54y73wq7b******
QuicUpgradeEnabled	boolean	任意	QUIC アップグレードを有効にするかどうかを指定します。有効な値： true：QUIC アップグレードを有効にします。 false (デフォルト)：QUIC アップグレードを無効にします。説明 HTTPS リスナーのみがこのパラメーターをサポートします。	false
Certificates	array<object>	任意	各証明書の詳細。
	object	任意	証明書の構成。
CertificateId	string	任意	証明書の ID。サーバー証明書のみがサポートされています。最大 20 個の証明書 ID を指定できます。	103705*******
CaCertificates	array<object>	任意	認証局 (CA) 証明書。CA 証明書は 1 つだけ指定できます。
	object	任意	CA 階層。
CertificateId	string	任意	CA 証明書の ID。説明このパラメーターは、CaEnabled が true に設定されている場合に必須です。	123157*******
DefaultActions	array<object>	必須	転送ルールのアクション。
	array<object>	必須
ForwardGroupConfig	object	必須	転送アクションの構成。最大 20 個のアクションを指定できます。
ServerGroupTuples	array<object>	必須	リクエストが転送される宛先サーバーグループ。
	object	必須
ServerGroupId	string	必須	リクエストが転送されるサーバーグループの ID。	sgp-8ilqs4axp6******
Type	string	必須	アクションタイプ。アクションタイプは 1 つだけ指定できます。有効な値： ForwardGroup：リクエストを複数のサーバーグループに転送します。	ForwardGroup
Tag	array<object>	任意	タグ。
	object	任意
Key	string	任意	タグキー。タグキーは最大 128 文字で、`acs:` または `aliyun` で始めることはできません。`http://` または `https://` を含めることはできません。	env
Value	string	任意	タグ値。タグ値は最大 128 文字で、`acs:` または `aliyun` で始めることはできません。`http://` または `https://` を含めることはできません。	product

レスポンスフィールド

フィールド	型	説明	例
	object
JobId	string	非同期タスクの ID。	72dcd26b-f12d-4c27-b3af-18f6aed5****
ListenerId	string	リスナーの ID。	lsn-o4u54y73wq7b******
RequestId	string	リクエストの ID。	CEF72CEB-54B6-4AE8-B225-F876*******

例

成功レスポンス

JSONJSON

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "ListenerId": "lsn-o4u54y73wq7b******",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876*******"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ResourceAlreadyExist.Listener	The specified resource %s is already exist.
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.
400	ResourceQuotaExceeded.LoadBalancerListenersNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	OperationDenied.CrossLoadBalancerQUICListener	The operation is not allowed because of %s.
400	ResourceAlreadyAssociated.Listener	The specified resource %s is already associated.
400	ResourceQuotaExceeded.SecurityPolicyAttachedNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	ResourceQuotaExceeded.ServerGroupAttachedNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	ResourceQuotaExceeded.LoadBalancerServersNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	ResourceQuotaExceeded.ServerAddedNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	Mismatch.VpcId	The %s is mismatched for %s and %s.
400	OperationDenied.ServerGroupProtocolNotSupport	The operation is not allowed because of ServerGroupProtocolNotSupport.
400	OperationDenied.GRPCServerGroup	The operation is not allowed because of %s.
400	Mismatch.LoadBalancerEditionAndConnectionDrain	The %s and %s are mismatched.
400	Mismatch.LoadBalancerEditionAndSlowStartEnable	The %s and %s are mismatched.
400	InvalidParameter	Invalid parameter, please check the parameter input.
403	Forbidden.SecurityPolicy	Authentication has failed for SecurityPolicy.
403	Forbidden.LoadBalancer	Authentication is failed for %s.
403	Forbidden.Listener	Authentication is failed for %s.
404	ResourceNotFound.LoadBalancer	The specified resource %s is not found.
404	ResourceNotFound.ServerGroup	The specified resource %s is not found.
404	ResourceNotFound.SecurityPolicy	The specified resource %s is not found.
404	ResourceNotFound.Listener	The specified resource %s is not found.
404	ResourceNotFound.Certificate	The specified resource %s is not found.

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

変更履歴

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