CreateListener を呼び出してリスナーを作成 - SLB - Alibaba Cloud - Server Load Balancer

リスナーを作成します。

操作説明

CreateListener は非同期操作です。リクエストが成功するとリクエスト ID が返されますが、リスナーはバックグラウンドで作成されます。GetListenerAttribute を呼び出して、リスナーの作成ステータスを照会できます。

Provisioning 状態は、リスナーが作成中であることを示します。
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	必須	Application Load Balancer (ALB) インスタンスの ID です。	alb-n5qw04uq8vavfe****
ClientToken	string	任意	リクエストのべき等性を保証するためにクライアントが生成するトークンです。トークンは、異なるリクエスト間で一意にする必要があり、ASCII 文字のみ使用できます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を自動的に ClientToken として使用します。RequestId は API リクエストごとに一意です。	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値： true：ドライランを実行し、リクエストの潜在的な問題 (必須パラメーター、リクエスト形式、サービス制限など) をチェックします。リスナーは作成されません。リクエストがチェックに失敗した場合、システムはエラーを返します。リクエストがチェックに合格した場合、システムは `DryRunOperation` エラーコードを返します。 false (デフォルト)：リクエストを送信します。リクエストがチェックに合格した場合、システムは操作を実行し、HTTP 2xx ステータスコードを返します。	false
ListenerProtocol	string	必須	リスナーのプロトコルです。有効な値： HTTP、HTTPS、QUIC。	HTTP
ListenerPort	integer	必須	リスナーが使用するフロントエンドポートです。有効な値： 1～65535。	80
ListenerDescription	string	任意	リスナーのカスタム名です。名前は 2～256 文字で、英字、数字、ハイフン (-)、スラッシュ (/)、ピリオド (.)、アンダースコア (_) 、および中国語文字を使用できます。	HTTP_80
RequestTimeout	integer	任意	リクエストのタイムアウト時間 (秒) です。有効な値： 1～600。デフォルト値： 60。バックエンドサーバーがタイムアウト期間内に応答しない場合、ロードバランサーはクライアントに `HTTP 504` エラーを返します。説明クォータの引き上げを申請すると、最大 3,600 秒まで延長できます。	60
IdleTimeout	integer	任意	アイドルタイムアウト時間 (秒) です。有効な値： 1～600。デフォルト値： 15。アイドルタイムアウト期間内に接続でリクエストが受信されない場合、ロードバランサーは接続を閉じます。次のリクエストのために新しい接続が確立されます。説明クォータの引き上げを申請すると、最大 3,600 秒まで延長できます。	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-Client-Cert-Client-Verify` ヘッダーを使用してクライアント証明書の検証結果を取得するかどうかを指定します。有効な値： true：この機能を有効にします。 false (デフォルト)：この機能を無効にします。説明このパラメーターは HTTPS リスナーでのみ使用できます。	true
XForwardedForClientCertFingerprintAlias	string	任意	カスタムヘッダーの名前です。このパラメーターは、XForwardedForClientCertFingerprintEnabled が true に設定されている場合にのみ有効になります。名前の長さは 1～40 文字で、小文字の英字、数字、ハイフン (-)、アンダースコア (_) を使用できます。説明このパラメーターは HTTPS リスナーでのみ使用できます。	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	任意	`X-Forwarded-Client-Cert-Fingerprint` ヘッダーを使用してクライアント証明書のフィンガープリントを取得するかどうかを指定します。有効な値： true：この機能を有効にします。 false (デフォルト)：この機能を無効にします。説明このパラメーターは HTTPS リスナーでのみ使用できます。	true
XForwardedForClientCertIssuerDNAlias	string	任意	カスタムヘッダーの名前です。このパラメーターは、XForwardedForClientCertIssuerDNEnabled が true に設定されている場合にのみ有効になります。名前の長さは 1～40 文字で、小文字の英字、数字、ハイフン (-)、アンダースコア (_) を使用できます。説明このパラメーターは HTTPS リスナーでのみ使用できます。	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	任意	`X-Forwarded-Client-Cert-Issuer-DN` ヘッダーを使用してクライアント証明書の発行者に関する情報を取得するかどうかを指定します。有効な値： true：この機能を有効にします。 false (デフォルト)：この機能を無効にします。説明このパラメーターは HTTPS リスナーでのみ使用できます。	true
XForwardedForClientCertSubjectDNAlias	string	任意	カスタムヘッダーの名前です。このパラメーターは、XForwardedForClientCertSubjectDNEnabled が true に設定されている場合にのみ有効になります。名前の長さは 1～40 文字で、小文字の英字、数字、ハイフン (-)、アンダースコア (_) を使用できます。説明このパラメーターは HTTPS リスナーでのみ使用できます。	test_subject-dn-alias_123456
XForwardedForClientCertSubjectDNEnabled	boolean	任意	`X-Forwarded-Client-Cert-Subject-DN` ヘッダーを使用してクライアント証明書の所有者に関する情報を取得するかどうかを指定します。有効な値： true：この機能を有効にします。 false (デフォルト)：この機能を無効にします。説明このパラメーターは HTTPS リスナーでのみ使用できます。	true
XForwardedForClientSrcPortEnabled	boolean	任意	`X-Forwarded-Client-Srcport` ヘッダーを使用してクライアントの送信元ポートを取得するかどうかを指定します。有効な値： true：この機能を有効にします。 false (デフォルト)：この機能を無効にします。説明このパラメーターは HTTP および HTTPS リスナーで使用できます。	true
XForwardedForEnabled	boolean	任意	`X-Forwarded-For` ヘッダーを使用してクライアント IP アドレスを取得するかどうかを指定します。有効な値： true (デフォルト)：この機能を有効にします。 false：この機能を無効にします。説明このパラメーターを true に設定した場合、XForwardedForProcessingMode のデフォルト値は append です。値を remove に変更できます。このパラメーターを false に設定した場合、ALB は `X-Forwarded-For` ヘッダーを保持し、バックエンドサーバーにリクエストを送信する前に追加の処理を行いません。このパラメーターは HTTP および HTTPS リスナーで使用できます。	true
XForwardedForProcessingMode	string	任意	`X-Forwarded-For` ヘッダーの処理モードです。このパラメーターは、XForwardedForEnabled が true に設定されている場合にのみ有効になります。有効な値： append (デフォルト)：`X-Forwarded-For` ヘッダーに最終ホップの IP アドレスを追加します。 remove：`X-Forwarded-For` ヘッダーを削除します。説明値を append に設定した場合、ALB はバックエンドサーバーにリクエストを送信する前に、`X-Forwarded-For` ヘッダーに最終ホップの IP アドレスを追加します。値を remove に設定した場合、ALB はリクエストに `X-Forwarded-For` ヘッダーが含まれているかどうかに関係なく、バックエンドサーバーにリクエストを送信する前に `X-Forwarded-For` ヘッダーを削除します。このパラメーターは HTTP および HTTPS リスナーで使用できます。	append
XForwardedForProtoEnabled	boolean	任意	`X-Forwarded-Proto` ヘッダーを使用して ALB インスタンスのリスナープロトコルを取得するかどうかを指定します。有効な値： true：この機能を有効にします。 false (デフォルト)：この機能を無効にします。説明このパラメーターは HTTP、HTTPS、QUIC リスナーで使用できます。	false
XForwardedForSLBIdEnabled	boolean	任意	`SLB-ID` ヘッダーを使用して ALB インスタンスの ID を取得するかどうかを指定します。有効な値： true：この機能を有効にします。 false (デフォルト)：この機能を無効にします。説明このパラメーターは HTTP、HTTPS、QUIC リスナーで使用できます。	false
XForwardedForSLBPortEnabled	boolean	任意	`X-Forwarded-Port` ヘッダーを使用して ALB インスタンスのリスナーポートを取得するかどうかを指定します。有効な値： true：この機能を有効にします。 false (デフォルト)：この機能を無効にします。説明このパラメーターは 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 に基づくスロットリングなどの機能に使用されます。	10.1.1.0/24
XForwardedForHostEnabled	boolean	任意	`X-Forwarded-Host` ヘッダーを使用して、ALB インスタンスへのアクセスに使用されているドメイン名を取得するかどうかを指定します。有効な値： true：この機能を有効にします。 false (デフォルト)：この機能を無効にします。説明このパラメーターは HTTP、HTTPS、QUIC リスナーで使用できます。	false
QuicConfig	object	任意	関連付けられている QUIC リスナーの設定です。
QuicListenerId	string	任意	リスナーに関連付ける QUIC リスナーの ID です。このパラメーターは、QuicUpgradeEnabled が true に設定されている場合、HTTPS リスナーに必須です。説明 HTTPS リスナーと関連する QUIC リスナーは、同じ ALB インスタンスに属している必要があります。また、その QUIC リスナーは、他のリスナーに既に関連付けられていない必要があります。	lsn-o4u54y73wq7b******
QuicUpgradeEnabled	boolean	任意	QUIC アップグレードを有効にするかどうかを指定します。有効な値： true：QUIC アップグレードを有効にします。 false (デフォルト)：QUIC アップグレードを無効にします。説明このパラメーターは HTTPS リスナーでのみ使用できます。	false
Certificates	array<object>	任意	サーバー証明書のリストです。
	object	任意	証明書です。
CertificateId	string	任意	デフォルトサーバー証明書の ID です。デフォルトサーバー証明書は 1 つのみ対応しています。説明このパラメーターは、ListenerProtocol が HTTPS または QUIC に設定されている場合に必須です。追加の証明書を関連付けるには、リスナーの作成後に AssociateAdditionalCertificatesWithListener API を呼び出します。	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 文字で、`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。	env
Value	string	任意	タグ値です。値は最大 128 文字で、`aliyun` または `acs:` で始めることはできず、`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.
400	OperationDenied.CACertificateCorrupted	The CA certificate is corrupted.
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.

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

変更履歴

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