AssociateAclsWithListener API による GA リスナーへの ACL バインド - GA - Alibaba Cloud - Global Accelerator

操作説明

AssociateAclsWithListener は非同期操作です。リクエストを送信すると、システムはリクエスト ID を返しますが、アクセスの制御ポリシーグループはまだリスナーに関連付けられていません。関連付けはバックグラウンドで実行を続けます。 DescribeListener を呼び出してリスナーのステータスを照会できます:
- リスナーが updating 状態の場合、アクセスの制御ポリシーグループはリスナーに関連付け中です。この状態では、クエリ操作のみ実行でき、他の操作は実行できません。
- リスナーが アクティブな 状態の場合、アクセスの制御ポリシーグループはリスナーに関連付けられています。
同じ Alibaba Cloud Global Accelerator (GA) インスタンス内で、アクセスの制御ポリシーグループをリスナーに同時に関連付けることはできません。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ga:AssociateAclsWithListener

update

*Listener

acs:ga:{#regionId}:{#accountId}:listener/{#ListenerId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	Global Accelerator インスタンスのリージョン ID。値を ap-southeast-1 に設定します。	cn-hangzhou
AclIds	array	必須	アクセスの制御ポリシーグループの ID。最大 2 つのアクセスの制御ポリシーグループを関連付けできます。
	string	任意	アクセスの制御ポリシーグループの ID。最大 2 つのアクセスの制御ポリシーグループを関連付けできます。	nacl-hp34s2h0xx1ht4nwo****
ListenerId	string	必須	リスナー ID。インテリジェントルーティングリスナーのみがアクセスの制御特徴をサポートしています。	lsr-bp1bpn0kn908w4nbw****
AclType	string	必須	アクセスの制御のタイプ。有効な値: white: 指定されたアクセスの制御ポリシーグループの設定項目にある IP アドレスまたは CIDR ブロックからのリクエストのみが転送されます。ホワイトリストは、特定の IP アドレスのみにアプリケーションへのアクセスを許可するシナリオに適用されます。ホワイトリストを有効にすると、ホワイトリスト内の IP アドレスのみが Global Accelerator リスナーにアクセスできます。ホワイトリストを有効にしても、アクセスの制御ポリシーグループに IP アドレスが含まれていない場合、Global Accelerator リスナーはすべてのリクエストを転送します。 black: 指定されたアクセスの制御ポリシーグループの設定項目にある IP アドレスまたは CIDR ブロックからのすべてのリクエストがブロックされます。ブラックリストは、特定の IP アドレスからのアプリケーションへのアクセスをブロックするシナリオに適用されます。ブラックリストを有効にしても、アクセスの制御ポリシーグループに IP アドレスが含まれていない場合、Global Accelerator リスナーはすべてのリクエストを転送します。	white
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは RequestId の値を ClientToken の値として使用します。RequestId の値は API リクエストごとに異なります。	02fb3da4****
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値: true: リソースを関連付けずにドライランを実行します。システムは必須パラメーター、リクエスト構文、およびビジネス制限を確認します。ドライランに失敗した場合、エラーメッセージが返されます。ドライランに成功した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト): ドライランを実行し、リクエストを送信します。ドライランに成功した場合、HTTP 2xx 状態コードが返され、操作が実行されます。	false

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	リクエスト ID。	64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF
AclIds	array	アクセスの制御ポリシーグループの ID。
	string	アクセスの制御ポリシーグループの ID。	nacl-hp34s2h0xx1ht4nwo****
ListenerId	string	リスナー ID。	lsr-bp1bpn0kn908w4nbw****

例

成功レスポンス

JSONJSON

{
  "RequestId": "64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF",
  "AclIds": [
    "nacl-hp34s2h0xx1ht4nwo****"
  ],
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	NotExist.Listener	listener %s is not exist
400	NotActive.Listener	listener %s is not active
400	NotExist.Accelerator	accelerator %s is not exist
400	StateError.Accelerator	accelerator state %s is illegal
400	NotExist.Acl	acl %s is not exist
400	StateError.Acl	acl state %s is illegal

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

変更履歴

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