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

Gateway Load Balancer（GWLB）インスタンスのリスナーを作成します。

操作説明

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gwlb:CreateListener

create

*LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadbalancerId}

*ServerGroup

acs:gwlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

*Listener

acs:gwlb:{#regionId}:{#accountId}:listener/*

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
LoadBalancerId	string	必須	GWLB インスタンスの ID です。	gwlb-te609d6696632f7*****
ListenerDescription	string	任意	リスナーの説明です。説明は 2 ～ 256 文字でなければなりません。中国語の文字、英字、数字、カンマ（ , ）、ピリオド（ . ）、セミコロン（ ; ）、スラッシュ（ / ）、アットマーク（ @ ）、アンダースコア（ _ ）、ハイフン（ - ）を使用できます。	listener-description
ServerGroupId	string	必須	サーバーグループ ID です。	sgp-ckh01px70dszof****
TcpIdleTimeout	integer	任意	アイドル状態の TCP 接続のタイムアウト期間です。有効な値: 60 ～ 6000 秒。デフォルト値: 350 秒。	350
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値: true: ドライランを実行します。システムは必須パラメーター、リクエスト形式、サービス制限を確認します。リクエストがドライランに失敗した場合、エラーメッセージが返されます。リクエストがドライランに合格した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト): リクエストを送信します。リクエストがチェックに合格した場合、HTTP 2xx ステータスコードが返され、操作が実行されます。	false
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークンです。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムはリクエストの RequestId を ClientToken として自動的に使用します。 RequestId はリクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-42665544****
Tag	array<object>	任意	タグです。呼び出しごとに最大 20 個のタグを指定できます。
	object	任意	タグです。
Key	string	任意	タグキーです。このパラメーターを指定する場合、空にすることはできません。タグキーは最大 128 文字で、`aliyun` または `acs:` で始めることはできません。 `http://` または `https://` を含めることはできません。	testKey
Value	string	任意	タグ値です。タグ値は最大 256 文字で、`http://` または `https://` を含めることはできません。	testValue

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	返されたデータです。
ListenerId	string	リスナー ID です。	lsn-wi3c0v30ivysrg****
RequestId	string	リクエスト ID です。	A045E652-D298-5E70-A978-7247135336FB

例

成功レスポンス

JSONJSON

{
  "ListenerId": "lsn-wi3c0v30ivysrg****",
  "RequestId": "A045E652-D298-5E70-A978-7247135336FB"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.
400	MissingParam.TagKey	The param of TagKey is missing.
400	MissingParam.TagValue	The param of TagValue is missing.
400	OperationDenied.TooManyListeners	The operation is not allowed because of TooManyListener.
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.
400	ResourceInUse.IP	The specified resource of IP is in use.
400	Mismatch.VpcId	The %s is mismatched for %s and %s.
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.
400	DuplicatedParam.TagKey	The param of %s is duplicated.
400	IllegalParam.TagKey	The param of %s is illegal.
400	IllegalParam.TagValue	The param of %s is illegal.
400	OperationDenied.TcpIdleTimeoutConflictWithScheduler	The TCP idle timeout of listener must be default value when the scheduling algorithm of server group is not 5TCH.
404	ResourceNotFound.LoadBalancer	The specified resource of %s is not found.
404	ResourceNotFound.ServerGroup	The specified resource of %s is not found.

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

変更履歴

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