アクセス制御リスト (ACL) をリスナーに関連付けます。

説明　

  • AssociateAclsWithListenerは非同期操作です。 リクエストを送信した後、システムはリクエストIDを返しますが、操作はシステムバックグラウンドで実行中です。 DescribeListener操作を呼び出して、ACLを関連付けるリスナーの状態を照会できます。
    • リスナーが更新中の状態にある場合は、ACLが関連付けられていることを示します。 この場合、クエリ操作のみを実行できます。
    • リスナーがアクティブ状態の場合、ACLが関連付けられていることを示します。
  • AssociateAclsWithListener操作は、特定の期間内に同じGlobal Accelerator (GA) インスタンスに対して繰り返し呼び出すことはできません。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須／任意 例: 説明　
操作 String 必須 AssociateAclsWithListener

実行する操作です。 値をAssociateAclsWithListenerに設定します。

RegionId String 必須 64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF

リージョンのID。

AclIds.N String 必須 nacl-hp34s2h0xx1ht4nwo ****

ACLのID。 最大2つのACL IDを関連付けることができます。

ListenerId String 必須 lsr-bp1bpn0kn908w4nbw****

リスナーの ID を示します。

AclType String 必須 白

ACLのタイプ。 有効な値：

  • white: ホワイトリスト。 ACLのIPアドレスまたはCIDRブロックからのリクエストのみが転送されます。 ホワイトリストは、特定のIPアドレスのみにアプリケーションへのアクセスを許可するシナリオに適用されます。 ホワイトリストが適切に構成されていないと、サービスに悪影響を及ぼす可能性があります。 リスナーにホワイトリストを設定すると、ホワイトリストに追加されたIPアドレスからのリクエストのみがリスナーによって転送されます。 ホワイトリストが有効になっていてもIPアドレスが追加されていない場合、リスナーはリクエストを転送しません。
  • black: ブラックリスト。 ACLのIPアドレスまたはCIDRブロックからの要求はすべて拒否されます。 ブラックリストは、特定のIPアドレスからアプリケーションへのアクセスを拒否するシナリオに適用されます。 ブラックリストが有効になっているが、IPアドレスが追加されていない場合、リスナーはすべてのリクエストを転送します。
ClientToken String 任意 02fb3da4 ****

リクエストのべき等性を保証するために使用されるクライアントトークン。

クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 ClientTokenにはASCII文字のみを含めることができます。

説明 このパラメーターを設定しない場合、ClientTokenはRequestIdの値に設定されます。 RequestIdの値は、APIリクエストごとに異なる場合があります。
DryRun Boolean いいえ false

リクエストのみを事前チェックするかどうかを指定します。 デフォルト値：false 有効な値：

  • true: 操作を実行せずにリクエストを事前チェックします。 システムは、必要なパラメーター、要求構文、および制限をチェックします。 リクエストが事前チェックに失敗した場合、エラーメッセージが返されます。 リクエストが事前チェックに合格した場合、DryRunOperationエラーコードが返されます。
  • false: リクエストを送信します。 リクエストが事前チェックに合格すると、2xx HTTPステータスコードが返され、操作が実行されます。

レスポンスパラメーター

項目 データ型 例: 説明　
RequestId String 64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF

リクエストの ID です。

AclIds 文字列の配列 nacl-hp34s2h0xx1ht4nwo ****

ACLのID。

ListenerId String lsr-bp1bpn0kn908w4nbw****

リスナーの ID を示します。

例

リクエストの例

http(s)://[Endpoint]/?Action=AssociateAclsWithListener
&RegionId=64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF
&AclIds=["nacl-hp34s2h0xx1ht4nwo ****"]
&ListenerId=lsr-bp1bpn0kn908w4nbw ****
&AclType=ホワイト
&ClientToken=02fb3da4 ****
&DryRun=false
&共通リクエストパラメータ

正常に処理された場合のレスポンス例

XML 形式 

HTTP/1.1 200 OK
Content-Type:application/xml

<AssociateAclsWithListenerResponse>
    <RequestId>64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF</RequestId>
    <AclIds>nacl-hp34s2h0xx1ht4nwo ****</AclIds>
    <ListenerId>lsr-bp1bpn0kn908w4nbw ****</ListenerId>
</AssociateAclsWithListenerResponse>

JSON 形式 

HTTP/1.1 200 OK
Content-Type:application/json

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

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。