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

CreateCustomRoutingEndpointGroups 操作を呼び出して、カスタムルーティングタイプのリスナーのエンドポイントグループをバッチで作成します。

操作説明

Global Accelerator は、リスナーのルーティングタイプで定義された転送メソッドに基づいて、エンドポイントグループ内のエンドポイントにトラフィックを割り当てます。

インテリジェントルーティングリスナーを設定すると、Alibaba Cloud Global Accelerator (GA) インスタンスは、レイテンシ要因（主に地理的位置とネットワークリンク条件に依存）に基づいて、最も近い正常なエンドポイントグループを自動的に選択してトラフィックを転送し、最終的にクライアントのネットワークアクセスリクエストを正常なエンドポイントに配信します。
カスタムルーティングタイプのリスナーを設定すると、Alibaba Cloud Global Accelerator (GA) インスタンスは、設定されたリスナーポート範囲、送信先エンドポイントグループのプロトコルとポート範囲、およびエンドポイント（vSwitch）の IP アドレス情報に基づいてポートマッピングテーブルを生成し、vSwitch 内の特定の IP アドレスとポートにトラフィックを確定的にルートします。

この操作は、カスタムルーティングタイプのリスナーのエンドポイントグループを作成します。インテリジェントルーティングリスナーのエンドポイントグループを作成するには、 CreateEndpointGroup を呼び出してください。

この操作を呼び出す際は、以下の項目に注意してください:

CreateCustomRoutingEndpointGroups は非同期操作です。リクエストを送信すると、システムはリクエスト ID を返しますが、カスタムルーティングタイプのリスナーのエンドポイントグループはまだ作成されていません。作成タスクはバックグラウンドで引き続き実行されます。 DescribeCustomRoutingEndpointGroup または ListCustomRoutingEndpointGroups を呼び出して、エンドポイントグループのステータスをクエリできます:
- エンドポイントグループが init 状態の場合、エンドポイントグループはバッチで作成中です。この状態では、クエリ操作のみ実行できます。
- すべてのエンドポイントグループが active 状態になると、バッチ作成は完了です。
CreateCustomRoutingEndpointGroups は、同じ Alibaba Cloud Global Accelerator (GA) インスタンス内でカスタムルーティングタイプのリスナーのエンドポイントグループの同時作成をサポートしていません。

事前準備

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

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

今すぐお試しください

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

create

*CustomRoutingEndpointGroup

acs:ga:{#regionId}:{#accountId}:ga/{#gaId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	Alibaba Cloud Global Accelerator (GA) インスタンスのリージョン ID。値を ap-southeast-1 に設定します。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的に RequestId の値を ClientToken の値として使用します。RequestId の値は API リクエストごとに異なります。	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値: true: カスタムルーティングタイプのエンドポイントグループを作成せずにドライランを実行します。システムは必須パラメーター、リクエストフォーマット、およびビジネス制限をチェックします。リクエストがドライランに失敗した場合、対応するエラーメッセージが返されます。リクエストがドライランに合格した場合、`DryRunOperation` エラーコードが返されます。 false（デフォルト）: 通常のリクエストを送信します。リクエストがチェックに合格した場合、HTTP 2xx 状態コードが返され、カスタムルーティングタイプのエンドポイントグループが作成されます。	false
AcceleratorId	string	必須	Alibaba Cloud Global Accelerator (GA) インスタンスの ID。	ga-bp1odcab8tmno0hdq****
ListenerId	string	必須	カスタムルーティングタイプのリスナーの ID。	lsr-bp1bpn0kn908w4nbw****
EndpointGroupConfigurations	array<object>	必須	エンドポイントグループの設定。最大 5 つのエンドポイントグループ設定を指定できます。
	array<object>	任意	エンドポイントグループの設定。最大 5 つのエンドポイントグループ設定を指定できます。
EndpointGroupRegion	string	必須	エンドポイントグループのリージョン ID。最大 5 つのエンドポイントグループリージョン ID を指定できます。	cn-hangzhou
Name	string	任意	エンドポイントグループの名前。名前は 1～128 文字で、英字または中国語文字で始まる必要があります。名前には数字、アンダースコア (_)、およびハイフン (-) を含めることができます。最大 5 つのエンドポイントグループ名を指定できます。	test
Description	string	任意	エンドポイントグループの説明。説明は最大 256 文字で、`http://` または `https://` を含めることはできません。最大 5 つのエンドポイントグループの説明を指定できます。	test
DestinationConfigurations	array<object>	任意	エンドポイントグループのマッピング設定。エンドポイントグループのバックエンドサービスポート範囲とプロトコルタイプを指定する必要があります。指定された情報は、関連付けられたリスナーポート範囲とのマッピング関係を形成します。各エンドポイントグループに対して、最大 20 のマッピングポート範囲とプロトコルタイプのエントリを指定できます。
	object	任意	エンドポイントグループのマッピング設定。エンドポイントグループのバックエンドサービスポート範囲とプロトコルタイプを指定する必要があります。指定された情報は、関連付けられたリスナーポート範囲とのマッピング関係を形成します。各エンドポイントグループに対して、最大 20 のマッピングポート範囲とプロトコルタイプのエントリを指定できます。
Protocols	array	任意	エンドポイントグループのバックエンドサービスのプロトコルタイプ。各エンドポイントグループのマッピングポート範囲とプロトコルタイプのエントリごとに、最大 4 つのバックエンドサービスプロトコルタイプを指定できます。
	string	任意	バックエンドサービスのプロトコル。有効値： TCP: TCP。 UDP: UDP。 TCP,UDP: TCP および UDP。マッピング構成ごとに最大 4 つのプロトコルを指定できます。	TCP
FromPort	integer	任意	エンドポイントグループのバックエンドサービスの開始ポート。有効な値: 1～65499。FromPort の値は ToPort の値以下である必要があります。各エンドポイントグループに対して、最大 20 の開始ポートエントリを指定できます。	80
ToPort	integer	任意	エンドポイントグループのバックエンドサービスの終了ポート。有効な値: 1～65499。FromPort の値は ToPort の値以下である必要があります。各エンドポイントグループに対して、最大 20 の終了ポートエントリを指定できます。	80
EndpointConfigurations	array<object>	任意	エンドポイントの設定。各エンドポイントグループに対して、最大 10 のエンドポイント設定を指定できます。
	array<object>	任意	エンドポイントの設定。各エンドポイントグループに対して、最大 10 のエンドポイント設定を指定できます。
Type	string	任意	エンドポイントのバックエンドサービスのタイプ。有効な値: PrivateSubNet（デフォルト）: 非公開 CIDR ブロック。	PrivateSubNet
Endpoint	string	任意	エンドポイントの vSwitch インスタンスの名前。	vsw-test01
TrafficToEndpointPolicy	string	任意	バックエンドサービスのトラフィックポリシー。有効な値: AllowAll: 指定されたバックエンドサービスへのすべてのトラフィックのアクセスを許可します。 DenyAll（デフォルト）: 指定されたバックエンドサービスへのすべてのトラフィックのアクセスを拒否します。 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 個のポート範囲を指定でき、トラフィックポリシーごとに最大 5 つのポート範囲を指定できます。
	object	任意	バックエンドサービスへのアクセスを許可されているポート範囲。ポート範囲は、バックエンドサービスのポート範囲内である必要があります。このパラメーターを空のままにすると、すべてのポートへのトラフィックアクセスが許可されます。このパラメーターは、TrafficToEndpointPolicy が AllowCustom に設定されている場合にのみ必須です。エンドポイントごとに最大 20 個のポート範囲を指定でき、トラフィックポリシーごとに最大 5 つのポート範囲を指定できます。
FromPort	integer	任意	許可されたポート範囲の最初のポート。このパラメーターの値は、バックエンドサービスのポート範囲内である必要があります。このパラメーターは、TrafficToEndpointPolicy が AllowCustom に設定されている場合にのみ必須です。エンドポイントごとに最大 20 個のポート範囲を指定でき、トラフィックポリシーごとに最大 5 つの最初のポートを指定できます。	80
ToPort	integer	任意	許可されたポート範囲の最後のポート。このパラメーターの値は、バックエンドサービスのポート範囲内である必要があります。このパラメーターは、TrafficToEndpointPolicy が AllowCustom に設定されている場合にのみ必須です。エンドポイントごとに最大 20 個のポート範囲を指定でき、トラフィックポリシーごとに最大 5 つの最後のポートを指定できます。	80

レスポンスフィールド

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

例

成功レスポンス

JSONJSON

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

エラーコード

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

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

変更履歴

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