CreateCustomRoutingEndpoints によるカスタムリスナー向けエンドポイントの作成 - GA - Alibaba Cloud - Global Accelerator

CreateCustomRoutingEndpoints 操作を呼び出して、カスタムルートタイプリスナーのエンドポイントを作成します。

操作説明

カスタムルートタイプリスナーを設定すると、Alibaba Cloud Global Accelerator (GA) インスタンスは、設定されたリスナーポート範囲、送信先エンドポイントグループのプロトコルとポート範囲、およびエンドポイント (vSwitch) の IP アドレス情報に基づいてポートマッピングテーブルを生成します。これにより、トラフィックは vSwitch 内の特定の IP アドレスとポートに確定的にルーティングされます。

この操作は、カスタムルートタイプリスナーのエンドポイントを作成します。この操作を呼び出す際は、以下の項目に注意してください:

CreateCustomRoutingEndpoints は非同期操作です。リクエストが送信されると、システムはリクエスト ID を返しますが、エンドポイントはまだ作成されていません。作成ノードはバックグラウンドで実行を続けます。 DescribeCustomRoutingEndpointGroup 操作を呼び出してエンドポイントグループのステータスを照会し、エンドポイントが作成されたかどうかを確認できます:
- エンドポイントグループが updating 状態の場合、エンドポイントは作成中です。この状態では、クエリ操作のみを実行できます。
- エンドポイントグループがアクティブな状態の場合、エンドポイントは作成されています。
CreateCustomRoutingEndpoints 操作は、同じ Alibaba Cloud Global Accelerator (GA) インスタンス内でカスタムルートリスナーのエンドポイントを作成する同時リクエストをサポートしていません。

事前準備

カスタムルートタイプリスナーのエンドポイントを作成する前に、以下の操作が完了していることを確認してください:

標準 Global Accelerator インスタンスが作成されていること。詳細については、 CreateAccelerator を参照してください。
帯域幅プランが標準 Alibaba Cloud Global Accelerator (GA) インスタンスにアタッチされていること。詳細については、 BandwidthPackageAddAccelerator を参照してください。
アプリケーションが Global Accelerator のバックエンドサービスとしてデプロイされ、転送されたリクエストを受け入れること。カスタムルートタイプリスナーは、バックエンドサービスタイプとして vSwitch のみをサポートしています。
カスタムルートタイプリスナーの使用権限を取得し、カスタムルートタイプリスナーを作成していること。リスナーのカスタムルートタイプは招待プレビュー中です。この特徴を使用するには、アカウントマネージャーに連絡してください。カスタムルートタイプリスナーの作成については、 CreateListener を参照してください。
カスタムルートタイプリスナーのエンドポイントグループが作成されていること。詳細については、 CreateCustomRoutingEndpointGroups を参照してください。

今すぐお試しください

この 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:CreateCustomRoutingEndpoints

create

*CustomRoutingEndpointGroup

acs:ga:{#regionId}:{#accountId}:customroutingendpointgroup/{#customroutingendpointgroupId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	Alibaba Cloud Global Accelerator (GA) インスタンスのリージョン ID。値を cn-hangzhou に設定します。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的に RequestId の値を ClientToken の値として使用します。RequestId の値は API リクエストごとに異なります。	123e4567-e89b-12d3-a456-426655440000
EndpointGroupId	string	必須	エンドポイントを作成するエンドポイントグループの ID。	epg-bp1bpn0kn908w4nb****
EndpointConfigurations	array<object>	必須	エンドポイント設定。最大 20 個のエンドポイント設定を指定できます。
	array<object>	任意	エンドポイント設定。最大 20 個のエンドポイント設定を指定できます。
Type	string	任意	エンドポイントのバックエンドサービスタイプ。有効な値: PrivateSubNet (デフォルト): 非公開 CIDR ブロック。	PrivateSubNet
Endpoint	string	任意	エンドポイント vSwitch のインスタンス ID。	vsw-test01
TrafficToEndpointPolicy	string	任意	バックエンドサービスのトラフィックポリシー。有効な値: DenyAll (デフォルト): 指定されたバックエンドサービスへのすべてのトラフィックを拒否します。 AllowAll: 指定されたバックエンドサービスへのすべてのトラフィックを許可します。 AllowCustom: 指定された送信先へのトラフィックのみを許可します。送信先の IP アドレスとポート範囲を指定する必要があります。ポート範囲が空の場合、送信先のすべてのポートがサポートされます。	DenyAll
PolicyConfigurations	array<object>	任意	トラフィック送信先の設定。各エンドポイントに最大 20 個のトラフィック送信先を指定できます。
	array<object>	必須	トラフィック送信先の設定。各エンドポイントに最大 20 個のトラフィック送信先を指定できます。
Address	string	必須	トラフィックを受信できるトラフィック送信先の IP アドレス。このパラメーターは、TrafficToEndpointPolicy が AllowCustom に設定されている場合にのみ効果があります。各エンドポイントに最大 20 個のトラフィック送信先 IP アドレスを指定できます。	10.0.XX.XX
PortRanges	array<object>	任意	トラフィックを受信できるトラフィック送信先のポート範囲。ポート範囲は、エンドポイントグループのバックエンドサービスポート範囲内に収まる必要があります。このパラメーターが空の場合、トラフィック送信先のすべてのポートがサポートされます。このパラメーターは、TrafficToEndpointPolicy が AllowCustom に設定されている場合にのみ効果があります。各エンドポイントに最大 20 個のポート範囲を指定でき、各トラフィック送信先に最大 20 個のポート範囲を指定できます。
	object	任意	トラフィックの転送先のポート範囲。このパラメーターの値は、エンドポイントグループのポート範囲内にある必要があります。このパラメーターを空のままにすると、トラフィックはすべての宛先ポートに転送されます。このパラメーターは、TrafficToEndpointPolicy が AllowCustom に設定されている場合にのみ有効になります。各エンドポイントに最大 20 個の宛先のポート範囲を指定でき、各宛先に最大 20 個のポート範囲を指定できます。
FromPort	integer	任意	宛先ポート範囲の最初のポート。このパラメーターの値は、エンドポイントグループのポート範囲内にある必要があります。このパラメーターは、TrafficToEndpointPolicy が AllowCustom に設定されている場合にのみ有効になります。各エンドポイントに最大 20 個の宛先のポート範囲を指定でき、各宛先に最大 20 個の最初のポートを指定できます。	80
ToPort	integer	任意	宛先ポート範囲の最後のポート。このパラメーターの値は、エンドポイントグループのポート範囲内にある必要があります。このパラメーターは、TrafficToEndpointPolicy が AllowCustom に設定されている場合にのみ有効になります。各エンドポイントに最大 20 個の宛先のポート範囲を指定でき、各宛先に最大 20 個の最後のポートを指定できます。	80

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	リクエスト ID。	04F0F334-1335-436C-A1D7-6C044FE73368
EndpointIds	array	エンドポイント ID のリスト。
	string	エンドポイント ID のリスト。	epg-bp1dmlohjjz4kqaun****

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	NotExist.EndPointGroup	endpoint group %s is not exist
400	StateError.Accelerator	accelerator state %s is illegal
400	StateError.EndPointGroup	endpoint group state %s is illegal

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

変更履歴

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