カスタムルーティングリスナーのエンドポイントを変更します。

説明

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

デバッグ

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

リクエストパラメーター

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

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

RegionId String 必須 cn-hangzhou

GAインスタンスがデプロイされているリージョンのID。 値をcn-hangzhouに設定します。

ClientToken String 任意 123e4567-e89b-12d3-a456-426655440000

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

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

説明 このパラメーターを設定しない場合、ClientTokenはRequestIdの値に設定されます。 RequestIdの値は、APIリクエストごとに異なる場合があります。
EndpointGroupId String 必須 epg-bp1bpn0kn908w4nb ****

変更するエンドポイントが属するエンドポイントグループのID。

N.TrafficToEndpointPolicy String 任意 DenyAll

指定されたエンドポイントのトラフィックのアクセスポリシー。 デフォルト値: DenyAll。 有効な値：

  • DenyAll: エンドポイントへのすべてのトラフィックを拒否します。
  • AllowAll: エンドポイントへのすべてのトラフィックを許可します。

  • AllowCustom: 指定した宛先へのトラフィックのみを許可します。

    このパラメーターをAllowCustomに設定した場合、トラフィックを許可する宛先のIPアドレスとポート範囲を指定する必要があります。 IPアドレスのみを指定し、ポート範囲を指定しない場合、GAはトラフィックをすべてのポートと宛先の指定されたIPアドレスに転送できます。

指定したエンドポイントのトラフィックのアクセスポリシーを最大20個指定できます。

N.EndpointId String 任意 ep-bp1dmlohjjz4kqaun ****

エンドポイントの ID

最大20のエンドポイントIDを指定できます。

N.PolicyConfigurations.N. アドレス String 任意 10.0.XX.XX

トラフィックを許可する宛先の IP アドレスです。

このパラメーターは、TrafficToEndpointPolicyがAllowCustomに設定されている場合にのみ有効になります。

各エンドポイントに最大20の宛先IPアドレスを指定できます。

N.PolicyConfigurations.N.PortRanges.N.FromPort String 任意 80

トラフィックを許可する宛先のポート範囲の開始ポート。 指定されたポートは、指定されたエンドポイントグループのポート範囲内にある必要があります。

このパラメーターは、TrafficToEndpointPolicyがAllowCustomに設定されている場合にのみ有効になります。

各エンドポイントに最大20の宛先のポート範囲を指定し、各宛先に最大20の開始ポートを指定できます。

N.PolicyConfigurations.N.PortRanges.N.ToPort String 任意 80

トラフィックを許可する宛先のポート範囲の終了ポート。 指定されたポートは、指定されたエンドポイントグループのポート範囲内にある必要があります。

このパラメーターは、TrafficToEndpointPolicyがAllowCustomに設定されている場合にのみ有効になります。

各エンドポイントに最大20の宛先のポート範囲を指定し、各宛先に最大20のエンドポートを指定できます。

レスポンスパラメーター

項目 データ型 例: 説明
RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

リクエストの ID です。

エンドポイントIds 文字列の配列 ep-bp1dmlohjjz4kqaun ****

エンドポイントのID。

例

リクエストの例

http(s)://[Endpoint]/? アクション=UpdateCustomRoutingEndpoints
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&EndpointGroupId=epg-bp1bpn0kn908w4nb ****
&EndpointConfigurations=[{"TrafficToEndpointPolicy":"DenyAll","EndpointId":"ep-bp1dmlohjjz4kqaun ****","PolicyConfigurations":[{"Address":"10.0.XX.XX","PortRanges":[{"FromPort"]: "80","80"}]}]
&<共通リクエストパラメーター>

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

XML 形式 

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

<UpdateCustomRoutingEndpointsResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <EndpointIds>ep-bp1dmlohjjz4kqaun ****</EndpointIds>
</UpdateCustomRoutingEndpointsResponse>

JSON 形式 

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

{
  "RequestId" : "04F0F334-1335-436C-A1D7-6C044FE73368" 、
  "EndpointIds" : [ "ep-bp1dmlohjjz4kqaun ****"]
}

エラーコード

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