CreateEndpointGroups - - Alibaba Cloud ドキュメントセンター

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

操作説明

この操作は、エンドポイントグループをバッチで作成します。1 つのリクエストでデフォルトエンドポイントグループと仮想エンドポイントグループを同時に作成することはできません。
この操作は、レイヤー 4 リスナーの仮想エンドポイントグループの作成をサポートしていません。レイヤー 4 リスナーの仮想エンドポイントグループを作成するには、CreateEndpointGroup 操作を呼び出します。
CreateEndpointGroups は非同期操作です。リクエストが送信されると、システムはリクエスト ID を返しますが、エンドポイントグループはすぐには作成されません。システムはバックグラウンドでエンドポイントグループを作成します。DescribeEndpointGroup または ListEndpointGroups 操作を呼び出して、エンドポイントグループの状態を照会できます：
- エンドポイントグループが init 状態の場合、エンドポイントグループは作成中です。この状態では、クエリ操作のみを実行できます。
- すべてのエンドポイントグループが active 状態の場合、エンドポイントグループは作成済みです。
CreateEndpointGroups 操作を呼び出して、同じ 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	必須	GA インスタンスがデプロイされているリージョンの ID。値を cn-hangzhou に設定します。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントでこのパラメーターの値を生成します。値が異なるリクエスト間で一意であることを確認してください。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエストの RequestId を ClientToken として使用します。RequestId はリクエストごとに異なる場合があります。	1F4B6A4A-C89E-489E-BAF1-52777EE148EF
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効値： true：ドライランを実行します。システムは、必須パラメーター、リクエストフォーマット、およびサービス制限を確認します。リクエストがドライランに失敗すると、エラーメッセージが返されます。リクエストがドライランに成功すると、システムは HTTP 2xx ステータスコードを返します。 false (デフォルト)：ドライランを実行し、リクエストを送信します。リクエストがドライランに成功すると、2xx HTTP ステータスコードが返され、操作が呼び出されます。	true
AcceleratorId	string	必須	GA インスタンスの ID。	ga-bp1odcab8tmno0hdq****
ListenerId	string	必須	リスナーの ID。説明リスナープロトコルが HTTP または HTTPS の場合、呼び出しごとに 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 http または HTTP 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：Alibaba Cloud Elastic Compute Service (ECS) インスタンス。 SLB：Alibaba Cloud Server Load Balancer (SLB) インスタンス。 ALB：Alibaba Cloud Application Load Balancer (ALB) インスタンス。 OSS：Alibaba Cloud Object Storage Service (OSS) バケット。 ENI：Alibaba Cloud Elastic Network Interface (ENI)。 NLB：Alibaba Cloud Network Load Balancer (NLB) インスタンス。エンドポイントグループに対して最大 100 個のエンドポイントタイプを指定できます。説明このパラメーターは、リスナーのルーティングタイプが Standard の場合に必須です。スマートルーティングを使用するリスナーに対して、エンドポイントグループとエンドポイントを設定できます。エンドポイントタイプを ECS、ENI、SLB、ALB、NLB、または IpTarget に設定し、サービスリンクロールが存在しない場合、システムは自動的に AliyunServiceRoleForGaVpcEndpoint という名前のサービスリンクロールを作成します。エンドポイントタイプを ALB に設定し、サービスリンクロールが存在しない場合、システムは自動的に AliyunServiceRoleForGaAlb という名前のサービスリンクロールを作成します。エンドポイントタイプを OSS に設定し、サービスリンクロールが存在しない場合、システムは自動的に AliyunServiceRoleForGaOss という名前のサービスリンクロールを作成します。エンドポイントタイプを NLB に設定し、サービスリンクロールが存在しない場合、システムは自動的に AliyunServiceRoleForGaNlb という名前のサービスリンクロールを作成します。説明詳細については、「サービスリンクロール」をご参照ください。	Domain
Weight	integer	任意	エンドポイントの重み。有効値：0～255。説明エンドポイントの重みを 0 に設定すると、GA はそのエンドポイントへのトラフィックの配信を停止します。取り扱いには注意してください。	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 アドレスはデフォルトで保持されます。X-Forwarded-For ヘッダーからクライアント IP アドレスを取得できます。この機能は無効にできません。 `EnableClientIPPreservation` と `EnableProxyProtocol` の両方を `true` に設定することはできません。詳細については、「クライアント IP アドレスの保持」をご参照ください。	false
EnableProxyProtocol	boolean	任意	Proxy Protocol を使用してクライアント IP アドレスを保持するかどうかを指定します。有効値： true：Proxy Protocol を使用します。 false (デフォルト)：Proxy Protocol を使用しません。説明このパラメーターは、TCP リスナーのエンドポイントグループに対してのみ使用できます。 `EnableClientIPPreservation` と `EnableProxyProtocol` の両方を `true` に設定することはできません。詳細については、「クライアント IP アドレスの保持」をご参照ください。	false
VpcId	string	任意	VPC の ID。エンドポイントグループに対して 1 つの VPC ID を指定できます。説明このパラメーターは、エンドポイントタイプが IpTarget に設定されている場合にのみ必須であり、有効になります。	vpc-2zekzii824szm3hps****
VSwitchIds	array	任意	VPC 内の vSwitch のリスト。
	string	任意	vSwitch の ID。エンドポイントグループに対して最大 2 つの vSwitch ID を指定できます。説明このパラメーターは、エンドポイントタイプが IpTarget に設定されている場合にのみ必須であり、有効になります。 vSwitch は、VpcId パラメーターで指定された VPC に属している必要があります。	vsw-bp1b2qx7y2qqnbkan****
EndpointRequestProtocol	string	任意	バックエンドサービスのプロトコル。有効値： HTTP HTTPS 説明このパラメーターは、HTTP または HTTPS リスナーのエンドポイントグループを作成する場合にのみ設定できます。 HTTP リスナーの場合、バックエンドサービスプロトコルは HTTP である必要があります。	HTTPS
EndpointProtocolVersion	string	任意	バックエンドサービスプロトコルのバージョン。有効値： HTTP1.1 (デフォルト) HTTP2 説明このパラメーターは、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

レスポンスフィールド

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

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

変更履歴

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