API で GA エンドポイントグループ一括作成ガイド - Global Accelerator (GA) - Alibaba Cloud - Global Accelerator

エンドポイントグループを作成します。

操作説明

この API を使用して、複数のエンドポイントグループを一括で作成できます。ただし、デフォルトエンドポイントグループと仮想エンドポイントグループを 1 回の呼び出しで同時に作成することはできません。
この API は、レイヤー 4 リスナー向けの仮想エンドポイントグループの作成をサポートしていません。レイヤー 4 リスナー向けに仮想エンドポイントグループを作成する場合は、CreateEndpointGroup を呼び出してください。
CreateEndpointGroups は非同期 API です。リクエスト ID を返し、バックグラウンドでエンドポイントグループを作成します。エンドポイントグループのステータスを確認するには、DescribeEndpointGroup または ListEndpointGroups を呼び出してください。
- エンドポイントグループのステータスが init の場合、初期化中です。この状態では、エンドポイントグループのクエリのみ可能です。
- すべてのエンドポイントグループのステータスが active になった時点で、一括作成が完了します。
同一の Global Accelerator インスタンスに対して、CreateEndpointGroups を同時（コンカレント）に呼び出すことはできません。

今すぐお試しください

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

create

*EndpointGroup

acs:ga:{#regionId}:{#accountId}:endpointgroup/*

*Accelerator

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

*Listener

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

ga:AcceleratorMainland

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	アクセラレータがデプロイされているリージョンの ID です。cn-hangzhou を指定してください。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークンです。クライアント側でトークンを生成してください。異なるリクエスト間で一意となるようにしてください。`ClientToken` の値には ASCII 文字のみを使用できます。説明このパラメーターを指定しない場合、システムは自動的にリクエストの RequestId を ClientToken として使用します。RequestId は各 API リクエストごとに一意です。	1F4B6A4A-C89E-489E-BAF1-52777EE148EF
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効値： true：ドライランを実行しますが、リソースは作成しません。システムは必須パラメーター、リクエストフォーマット、サービス制限をチェックします。ドライランに失敗した場合はエラーメッセージが返されます。ドライランに成功した場合は、2xx HTTP ステータスコードが返されます。 false（デフォルト）：通常のリクエストを送信し、リクエストが成功した場合にリソースを作成します。	true
AcceleratorId	string	必須	アクセラレータの ID です。	ga-bp1odcab8tmno0hdq****
ListenerId	string	必須	リスナーの ID です。説明リスナープロトコルが HTTP または HTTPS の場合、各 CreateEndpointGroups 呼び出しで作成できるエンドポイントグループは 1 つだけです。	lsr-bp1bpn0kn908w4nbw****
EndpointGroupConfigurations	array<object>	必須	エンドポイントグループの構成です。最大 10 個のエンドポイントグループを構成できます。
	array<object>	任意	エンドポイントグループの構成です。
EndpointGroupName	string	任意	エンドポイントグループの名前です。名前は 1～128 文字で、英字または漢字で始まり、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。	group1
EndpointGroupDescription	string	任意	エンドポイントグループの説明です。説明は最大 200 文字まで指定でき、`http://` または `https://` で始めることはできません。	EndpointGroup
EndpointGroupRegion	string	必須	エンドポイントグループがデプロイされているリージョンの ID です。最大 10 個のエンドポイントグループリージョン ID を入力できます。	cn-hongkong
TrafficPercentage	integer	任意	エンドポイントグループへのトラフィックディストリビューションの割合です。インテリジェントルーティングリスナーが複数のエンドポイントグループに関連付けられている場合、このパラメーターはこのエンドポイントグループにルーティングされるトラフィックの割合を指定します。有効値：1～100。デフォルト値：100。最大 10 個のエンドポイントグループのトラフィックダイヤル値を入力できます。	100
HealthCheckEnabled	boolean	任意	エンドポイントグループのヘルスチェックを有効にするかどうかを指定します。有効値： true：ヘルスチェックを有効にします。 false（デフォルト）：ヘルスチェックを無効にします。最大 10 個のエンドポイントグループでヘルスチェックを有効にできます。	false
HealthCheckIntervalSeconds	integer	任意	ヘルスチェックの間隔（秒単位）です。最大 10 個のヘルスチェック間隔を入力できます。	5
HealthCheckPath	string	任意	ヘルスチェックに使用されるパスです。最大 10 個のヘルスチェックパスを入力できます。	/healthcheck
HealthCheckPort	integer	任意	ヘルスチェックに使用されるポートです。有効値：1～65535。最大 10 個のヘルスチェック用ポートを入力できます。	443
HealthCheckProtocol	string	任意	ヘルスチェックに使用されるプロトコルです。有効値： tcp または TCP：TCP プロトコル。 http または HTTP：HTTP プロトコル。 https または HTTPS：HTTPS プロトコル。最大 10 個のヘルスチェックプロトコルを入力できます。	HTTPS
ThresholdCount	integer	任意	エンドポイントが正常と見なされるために連続して成功する必要があるヘルスチェックの回数、または異常と見なされるために連続して失敗する必要があるヘルスチェックの回数です。有効値：2～10。デフォルト値：3。ヘルスステータスの変更に必要な連続ヘルスチェック回数の値を最大 10 個入力できます。	3
EndpointConfigurations	array<object>	任意	エンドポイントグループ内のエンドポイントの構成です。
	object	任意	エンドポイントの構成です。
Type	string	任意	インテリジェントルーティングリスナーにおけるエンドポイントのタイプです。有効値： Domain：カスタムドメイン名。 Ip：カスタム IP アドレス。 IpTarget：カスタムプライベート IP アドレス。 PublicIp：Alibaba Cloud パブリック IP アドレス。 ECS：ECS インスタンス。 SLB：SLB インスタンス。 ALB：ALB インスタンス。 OSS：OSS バケット。 ENI：エラスティックネットワークインターフェース。 NLB：NLB インスタンス。インテリジェントルーティングリスナーのエンドポイントグループでは、最大 100 個のエンドポイントを指定できます。説明リスナーのルーティングタイプが Standard（インテリジェントルーティング）の場合、リスナーのエンドポイントグループおよびエンドポイント情報を構成する必要があります。このパラメーターは必須です。 Type を ECS、ENI、SLB、または IpTarget に設定し、サービスリンクロールが存在しない場合、システムは自動的に AliyunServiceRoleForGaVpcEndpoint という名前のサービスリンクロールを作成します。 Type を ALB に設定し、サービスリンクロールが存在しない場合、システムは自動的に AliyunServiceRoleForGaAlb という名前のサービスリンクロールを作成します。 Type を OSS に設定し、サービスリンクロールが存在しない場合、システムは自動的に AliyunServiceRoleForGaOss という名前のサービスリンクロールを作成します。 Type を NLB に設定し、サービスリンクロールが存在しない場合、システムは自動的に AliyunServiceRoleForGaNlb という名前のサービスリンクロールを作成します。説明詳細については、「サービスリンクロール」をご参照ください。	Domain
Weight	integer	任意	エンドポイントの重みです。有効値：0～255。説明エンドポイントの重みを 0 に設定すると、Global Accelerator はそのエンドポイントへのトラフィック配信を停止します。慎重に操作してください。	255
Endpoint	string	任意	エンドポイントの IP アドレスまたはドメイン名です。インテリジェントルーティングリスナーのエンドポイントグループでは、最大 100 個のエンドポイント IP アドレスまたはドメイン名を入力できます。	1.1.1.1
SubAddress	string	任意	エラスティックネットワークインターフェース（ENI）のプライベート IP アドレスです。説明このパラメーターは、エンドポイントタイプが ENI の場合にのみ使用できます。このパラメーターを指定しない場合、システムは ENI のプライマリプライベート IP を使用します。	172.168.XX.XX
EnableClientIPPreservation	boolean	任意	クライアント IP アドレスを保持するかどうかを指定します。有効値： true：クライアント IP アドレスを保持します。 false（デフォルト）：クライアント IP アドレスを保持しません。説明 UDP および TCP リスナーのエンドポイントグループでは、クライアント IP 保持機能はデフォルトで無効になっています。ビジネス要件に基づいてこの機能を有効にできます。 HTTP および HTTPS リスナーのエンドポイントグループでは、クライアント IP 保持機能はデフォルトで有効になっています。クライアント IP アドレスは X-Forwarded-For ヘッダーに保持されます。この機能を無効にすることはできません。 `EnableClientIPPreservation` と `EnableProxyProtocol` を同時に `true` に設定することはできません。詳細については、「クライアント IP アドレスの保持」をご参照ください。	false
EnableProxyProtocol	boolean	任意	Proxy Protocol を使用してクライアント IP アドレスを保持するかどうかを指定します。有効値： true：Proxy Protocol を使用してクライアント IP アドレスを保持します。 false（デフォルト）：Proxy Protocol を使用してクライアント IP アドレスを保持しません。説明このパラメーターは、TCP リスナーに関連付けられたエンドポイントグループでのみ使用できます。 `EnableClientIPPreservation` と `EnableProxyProtocol` を同時に `true` に設定することはできません。詳細については、「クライアント IP アドレスの保持」をご参照ください。	false
VpcId	string	任意	VPC の ID です。インテリジェントルーティングリスナーのエンドポイントグループでは、VPC ID を 1 つだけ指定できます。説明このパラメーターは、Type を IpTarget に設定した場合にのみ必須です。	vpc-2zekzii824szm3hps****
VSwitchIds	array	任意	VSwitch ID のリストです。
	string	任意	VSwitch の ID です。インテリジェントルーティングリスナーのエンドポイントグループでは、最大 2 つの VSwitch ID を指定できます。説明このパラメーターは、エンドポイントタイプが IpTarget の場合にのみ必須であり、適用されます。 VSwitch は、VpcId パラメーターで指定された VPC 内にある必要があります。	vsw-bp1b2qx7y2qqnbkan****
Provider	string	任意		BAILIAN
ApiKeys	array	任意
	string	任意		sk-******
EndpointRequestProtocol	string	任意	バックエンドサービスのプロトコルです。有効値： HTTP HTTPS 説明このパラメーターは、HTTP または HTTPS リスナー向けのエンドポイントグループを作成する場合にのみ設定できます。 HTTP リスナーの場合、このパラメーターを HTTP にのみ設定できます。	HTTPS
EndpointProtocolVersion	string	任意	バックエンドサービスのプロトコルバージョンです。有効値： HTTP1.1（デフォルト）：HTTP 1.1。 HTTP2：HTTP 2。説明このパラメーターは、`EndpointRequestProtocol` が HTTPS に設定されている場合にのみ設定できます。	HTTP1.1
EndpointGroupType	string	任意	インテリジェントルーティングリスナーにおけるエンドポイントグループのタイプです。有効値： default（デフォルト）：デフォルトエンドポイントグループ。 virtual：仮想エンドポイントグループ。最大 10 個のエンドポイントグループタイプを入力できます。	default
PortOverrides	array<object>	任意	ポートオーバーライド設定です。
	object	任意	ポートオーバーライド設定です。
ListenerPort	integer	任意	リスナーポートです。有効値：1～65499。説明 TCP リスナーの場合、仮想エンドポイントグループのポートオーバーライドを構成することはできません。リスナーにすでに仮想エンドポイントグループが存在する場合、デフォルトエンドポイントグループのポートオーバーライドを構成することはできません。デフォルトエンドポイントグループにポートオーバーライドが構成されている場合、仮想エンドポイントグループを追加することはできません。ポートオーバーライドを構成した後、リスナープロトコルを変更することはできません（HTTP と HTTPS 間の切り替えを除く）。リスナーポート範囲を変更する場合、新しい範囲にはポートオーバーライドで使用されているすべてのリスナーポートが含まれている必要があります。たとえば、リスナーポート範囲が 80～82 で、ポートオーバーライドがリスナーポートをエンドポイントポート 100～102 にマッピングするように構成されている場合、リスナーポート範囲を 80～81 に変更することはできません。	80
EndpointPort	integer	任意	ポートオーバーライドに使用されるエンドポイントポートです。	443
Tag	array<object>	任意	エンドポイントグループに追加するタグです。最大 20 個のタグを指定できます。
	object	任意	エンドポイントグループのタグです。
Key	string	任意	タグキーです。タグキーは空文字列にできません。タグキーの長さは最大 64 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることもできません。最大 20 個のタグキーを入力できます。	tag-key
Value	string	任意	タグ値です。タグ値は空文字列にできます。タグ値の長さは最大 128 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることもできません。最大 20 個のタグ値を入力できます。	tag-value
SystemTag	array<object>	任意	このパラメーターは予約済みです。
	object	任意	このパラメーターは予約済みです。
Key	string	任意	このパラメーターは予約済みです。	-
Value	string	任意	このパラメーターは予約済みです。	-
Scope	string	任意	このパラメーターは予約済みです。	-
HealthCheckHost	string	任意	ヘルスチェックリクエストが送信されるドメイン名です。	www.taobao.com
EndpointIpVersion	string	任意	バックエンドサービスの IP バージョンです。有効値： IPv4（デフォルト）：Global Accelerator は IPv4 アドレスのみを使用してバックエンドサービスと通信します。 IPv6：Global Accelerator は IPv6 アドレスのみを使用してバックエンドサービスと通信します。 ProtocolAffinity：Global Accelerator は、クライアントリクエストと同じ IP バージョンを使用してバックエンドサービスと通信します。	IPv4

レスポンスフィールド

フィールド	型	説明	例
	object	返されたデータです。
RequestId	string	リクエスト ID です。	6FEA0CF3-D3B9-43E5-A304-D217037876A8
EndpointGroupIds	array	エンドポイントグループの ID です。
	string	エンドポイントグループの ID です。	epg-bp1dmlohjjz4kqaun****

例

成功レスポンス

JSONJSON

{
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
  "EndpointGroupIds": [
    "epg-bp1dmlohjjz4kqaun****"
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Domain.NotFit	The domain is not fit the rule
400	Resource.QuotaFull	The resource quota is exceeded.
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.
400	NotSupportHealthCheck.Accelerator	Currently Accelerator does not support health check.
400	EndpointGroupExclusive.Listener	All endpoint group must under the same listener.
400	RegionConflict.EndpointGroup	Endpoint group under the same listener must have different region.
400	ListenerProtocolIllegal.EndpointGroup	Listener protocol is illegal, the https/http listener instance is only allowed to have one default endpoint group.
400	QuotaExceeded.EndpointGroup	The number of endpoint group exceeds the limit.
400	ParamExclusive.EndpointGroupType	All endpoint group type group must be consistent.
400	HealthCheckPath.Illegal	Health check path illegal.
400	NotExist.Listener	The listener does not exist.	The listener does not exist.
400	NotActive.Listener	The state of the listener is not active.	The state of the listener is not active.
400	NotExist.Accelerator	The accelerated instance does not exist.	The accelerated instance does not exist.
400	StateError.Accelerator	The state of the accelerated instance is invalid.
400	NotExist.BusinessRegion	The business region does not exist.	The business region does not exist.
400	NotExist.BasicBandwidthPackage	You must specify the basic bandwidth package.	You must specify the basic bandwidth package.
400	QuotaExceeded.EndPoint	The maximum number of endpoints is exceeded.	The maximum number of endpoints is exceeded.
400	NoPermission.VpcEndpoint	You are not authorized to perform the operation.
400	EndPointRequestProtocolIllegal.EndpointGroup	endpoint group request protoco is illegal
400	QuotaExceeded.PortOverride	The number of port override exceeds the limit.
400	NotExist.ListenerPort	listener port %s is not exist
400	MixedVpc.EndPoint	VPC Endpoint cannot be mixed with other types of Endpoints.
400	IllegalPublicIp.EndPoint	The public IP address configured for the endpoint is invalid. Only an Alibaba Cloud public IP address in the region of the endpoint can be configured.

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

変更履歴

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