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

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

操作説明

この操作を呼び出して、エンドポイントグループを一括で作成できます。ただし、デフォルトエンドポイントグループと仮想エンドポイントグループを同時に作成することはできません。
この操作では、レイヤー 4 プロトコルリスナー用の仮想エンドポイントグループの作成はサポートされていません。レイヤー 4 プロトコルリスナー用の仮想エンドポイントグループを作成するには、 CreateEndpointGroup を使用します。
CreateEndpointGroups 操作は非同期です。システムはリクエスト ID を返しますが、エンドポイントグループはすぐには作成されません。バックグラウンドシステムでの作成ノードは引き続き進行中です。 DescribeEndpointGroup または ListEndpointGroups を呼び出して、エンドポイントグループのステータスをクエリできます。
- エンドポイントグループが init 状態の場合、エンドポイントグループが一括で作成されています。この状態では、クエリ操作のみ実行できます。
- すべてのエンドポイントグループが アクティブな 状態の場合、エンドポイントグループが作成されています。
CreateEndpointGroups 操作では、同じ Alibaba Cloud Global Accelerator (GA) インスタンス内でのエンドポイントグループを作成する同時操作はサポートされていません。

今すぐお試しください

この 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	必須	Alibaba Cloud Global Accelerator (GA) インスタンスのリージョン ID。値を cn-hangzhou に設定します。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみ含めることができます。説明このパラメーターを指定しない場合、システムは API 呼び出しの RequestId を ClientToken として自動的に使用します。各 API 呼び出しの RequestId は一意です。	1F4B6A4A-C89E-489E-BAF1-52777EE148EF
DryRun	boolean	任意	リクエストの事前チェックのみを実行するかどうかを指定します。有効な値: true: リソースを作成せずにリクエストを事前チェックします。システムは、必須パラメーターが指定されているか、リクエストフォーマット、およびサービスの制限を確認します。リクエストが事前チェックに失敗した場合、対応するエラーが返されます。リクエストが事前チェックに合格した場合、HTTP 2xx 状態コードが返されます。 false (デフォルト): リクエストを送信します。リクエストが事前チェックに合格した場合、HTTP 2xx 状態コードが返され、操作が実行されます。	true
AcceleratorId	string	必須	Alibaba Cloud Global Accelerator (GA) インスタンスの ID。	ga-bp1odcab8tmno0hdq****
ListenerId	string	必須	リスナー ID。説明リスナープロトコルが HTTP または HTTPS の場合、CreateEndpointGroups 操作の呼び出しの各時間で作成できるエンドポイントグループのリストは 1 つだけです。	lsr-bp1bpn0kn908w4nbw****
EndpointGroupConfigurations	array<object>	必須	エンドポイントグループの構成。最大 10 個のエンドポイントグループを指定できます。
	array<object>	任意	エンドポイントグループの構成。最大 10 個のエンドポイントグループを指定できます。
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	任意	2 回の連続するヘルスチェック間の間隔。単位: 秒。最大 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: Server Load Balancer (SLB) インスタンス ALB: Application Load Balancer (ALB) インスタンス OSS: Object Storage Service (OSS) インスタンス ENI: Alibaba Cloud エラスティックネットワークインターフェース (NIC) NLB: Network Load Balancer (NLB) インスタンスインテリジェントルーティングを使用するリスナーのエンドポイントグループで、最大 100 個のエンドポイントを指定できます。説明 Type (リスナールーティングタイプ) が標準 (インテリジェントルーティング) にセットされている場合、リスナーのエンドポイントグループとエンドポイント情報を構成でき、このパラメーターは必須です。エンドポイントタイプが ECS、ENI、SLB、ALB、NLB、または IpTarget に設定されており、サービス関連付けロールが存在しない場合、システムは呼び出しを行い、AliyunServiceRoleForGaVpcEndpoint という名前のサービス関連付けロールを自動的に作成します。エンドポイントタイプが ALB に設定されており、サービス関連付けロールが存在しない場合、システムは AliyunServiceRoleForGaAlb という名前のサービス関連付けロールを自動的に作成します。エンドポイントタイプが OSS に設定されており、サービス関連付けロールが存在しない場合、システムは AliyunServiceRoleForGaOss という名前のサービス関連付けロールを自動的に作成します。エンドポイントタイプが NLB に設定されており、サービス関連付けロールが存在しない場合、システムは AliyunServiceRoleForGaNlb という名前のサービス関連付けロールを自動的に作成します。説明詳細については、「サービス関連付けロール」を参照してください。	Domain
Weight	integer	任意	エンドポイントの重み。有効な値: 0～255。説明エンドポイントの重みが 0 に設定されている場合、Global Accelerator はエンドポイントへのトラフィックの分散を停止します。慎重に操作してください。	255
Endpoint	string	任意	インテリジェントルーティングを使用するリスナーのエンドポイントの IP アドレスまたはドメイン名。インテリジェントルーティングを使用するリスナーのエンドポイントグループで、最大 100 個の IP アドレスまたはドメイン名を指定できます。	1.1.1.1
SubAddress	string	任意	エラスティックネットワークインターフェース (NIC) の非公開 IP。説明エンドポイントタイプが ENI の場合、このパラメーターを構成できます。このパラメーターを構成しない場合、デフォルトでエラスティックネットワークインターフェース (NIC) のプライマリ非公開 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: クライアント IP アドレスの保持を有効にします。 false (デフォルト): クライアント IP アドレスの保持を無効にします。説明このパラメーターは、TCP リスナーのエンドポイントグループでのみサポートされています。 EnableClientIPPreservation と EnableProxyProtocol を同時に true にセットすることはできません。詳細については、「クライアント IP アドレスの保持」を参照してください。	false
VpcId	string	任意	VPC ID。インテリジェントルーティングを使用するリスナーのエンドポイントグループでは、VPC ID を 1 つだけ指定できます。説明このパラメーターは、エンドポイントタイプが IpTarget の場合にのみ有効かつ必須です。	vpc-2zekzii824szm3hps****
VSwitchIds	array	任意	VPC 内の vSwitch。
	string	任意	vSwitch ID。インテリジェントルーティングを使用するリスナーのエンドポイントグループで、最大 2 個の vSwitch ID を指定できます。説明このパラメーターは、エンドポイントタイプが IpTarget の場合にのみ有効かつ必須です。 vSwitch は、VpcId パラメーターで指定された VPC に属している必要があります。	vsw-bp1b2qx7y2qqnbkan****
Provider	string	任意	プロバイダー構成。	BAILIAN
ApiKeys	array	任意	エンドポイントグループ構成内の API キー。
	string	任意	エンドポイントグループ構成内の API キー。	sk-******
EndpointRequestProtocol	string	任意	バックエンドサービスの用語。有効な値: HTTP: HTTP HTTPS: 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>	任意	エンドポイントグループのタグ。
	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 (デフォルト): GA は IPv4 経由でのみエンドポイントサービスと通信します。 IPv6: GA は IPv6 経由でのみエンドポイントサービスと通信します。 ProtocolAffinity: GA はクライアントリクエストと同じ IP バージョンでエンドポイントサービスと通信します。	IPv4
ProxyTunnel	object	任意	プロキシトンネル構成。
ConnectAuthPrefix	string	任意	プロキシトンネル接続認証プレフィックス。	prefix-auth
ConnectAuthSuffix	string	任意	プロキシトンネル接続認証サフィックス。	suffix-auth
ConnectSessionHashHdr	string	任意	接続会話ハッシュヘッダー構成。	X-Session-Hash
ConnectTunnelTimeout	integer	任意	プロキシトンネル接続タイムアウト期間。	5000
TunnelServerPort	integer	任意	トンネルサーバーポート。	8443
TunnelServerType	string	任意	トンネルサーバータイプ。	domain
TunnelServer	string	任意	トンネルサーバー構成。	tunnel.example.com
HealthCheckMethod	string	任意	ヘルスチェックメソッド。	GET

レスポンスフィールド

フィールド	型	説明	例
	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.

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

変更履歴

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