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

CreateEndpointGroup 操作を呼び出して、エンドポイントグループを作成します。

操作説明

レイヤー 4 リスナーの仮想エンドポイントグループを作成する場合、デフォルトのエンドポイントグループが必要です。
CreateEndpointGroup は非同期操作です。リクエストの送信後、システムはエンドポイントグループ ID を返しますが、エンドポイントグループはまだバックグラウンドで作成中です。DescribeEndpointGroup 操作を呼び出して、エンドポイントグループの状態を照会できます。
- エンドポイントグループが init 状態の場合、作成中であることを示します。この状態では、クエリ操作のみを実行できます。
- エンドポイントグループが active 状態の場合、作成済みであることを示します。
CreateEndpointGroup 操作では、同じ Global Accelerator インスタンスに対してエンドポイントグループを同時に作成する呼び出しはサポートされていません。

今すぐお試しください

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

create

*EndpointGroup

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

*Listener

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

*Accelerator

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

ga:AcceleratorMainland

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	Global Accelerator インスタンスのリージョン ID。値を cn-hangzhou に設定します。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアント側でこのパラメーターの値を生成します。値がリクエスト間で一意であることを確認してください。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエストの RequestId を ClientToken として使用します。RequestId はリクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	必須	Global Accelerator インスタンスの ID。	ga-bp1odcab8tmno0hdq****
Name	string	任意	エンドポイントグループの名前。名前は、長さが 1～128 文字で、先頭は英字である必要があります。数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。	group1
Description	string	任意	エンドポイントグループの説明。説明は最大 200 文字で、`http://` または `https://` で始めることはできません。	EndpointGroup
EndpointGroupRegion	string	必須	エンドポイントグループを作成するリージョンの ID。	cn-hangzhou
ListenerId	string	必須	リスナーの ID。	lsr-bp1bpn0kn908w4nbw****
TrafficPercentage	integer	任意	リスナーが複数のエンドポイントグループに関連付けられている場合のエンドポイントグループのトラフィック比率。有効値：1～100。	20
HealthCheckIntervalSeconds	integer	任意	2 回の連続したヘルスチェックの間隔。単位：秒。	3
HealthCheckPath	string	任意	ヘルスチェックのパス。	/healthcheck
HealthCheckPort	integer	任意	ヘルスチェックに使用されるポート。	20
HealthCheckProtocol	string	任意	ヘルスチェックに使用されるプロトコル。有効値： tcp または TCP：TCP http または HTTP：HTTP https または HTTPS：HTTPS	tcp
ThresholdCount	integer	任意	正常なエンドポイントが異常と見なされるまでに必要な連続ヘルスチェック失敗回数、または異常なエンドポイントが正常と見なされるまでに必要な連続ヘルスチェック成功回数。有効値：2～10。デフォルト値：3。	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) インスタンス。説明エンドポイントタイプが ECS、ENI、SLB、ALB、NLB、または IpTarget に設定されていて、サービスリンクロールが存在しない場合、システムは自動的に AliyunServiceRoleForGaVpcEndpoint という名前のサービスリンクロールを作成します。エンドポイントタイプが ALB に設定されていて、サービスリンクロールが存在しない場合、システムは自動的に AliyunServiceRoleForGaAlb という名前のサービスリンクロールを作成します。エンドポイントタイプが OSS に設定されていて、サービスリンクロールが存在しない場合、システムは自動的に AliyunServiceRoleForGaOss という名前のサービスリンクロールを作成します。エンドポイントタイプが NLB に設定されていて、サービスリンクロールが存在しない場合、システムは自動的に AliyunServiceRoleForGaNlb という名前のサービスリンクロールを作成します。説明詳細については、「サービスリンクロール」をご参照ください。	Ip
EnableClientIPPreservation	boolean	任意	クライアント IP アドレスを保持するかどうかを指定します。有効値： true：クライアント IP アドレスを保持します。 false (デフォルト)：クライアント IP アドレスを保持しません。説明デフォルトでは、UDP および TCP リスナーのエンドポイントグループに対して、クライアント IP アドレスの保持は無効になっています。ビジネスニーズに基づいて有効にすることができます。 HTTP および HTTPS リスナーのエンドポイントグループでは、クライアント IP アドレスの保持がデフォルトで有効になっています。クライアント IP アドレスは X-Forwarded-For ヘッダーから取得されます。この機能は無効にできません。 EnableClientIPPreservation と EnableProxyProtocol の両方を true に設定することはできません。詳細については、「クライアント IP アドレスの保持」をご参照ください。	false
Weight	integer	必須	エンドポイントの重み。有効値：0～255。説明エンドポイントの重みを 0 に設定すると、Global Accelerator はそのエンドポイントへのトラフィックの配信を停止します。取り扱いには注意が必要です。	20
EnableProxyProtocol	boolean	任意	プロキシプロトコルを使用してクライアント IP アドレスを保持するかどうかを指定します。有効値： true：プロキシプロトコルを使用します。 false (デフォルト)：プロキシプロトコルを使用しません。説明このパラメーターは、TCP リスナーのエンドポイントグループでのみ使用できます。 EnableClientIPPreservation と EnableProxyProtocol の両方を true に設定することはできません。詳細については、「クライアント IP アドレスの保持」をご参照ください。	false
Endpoint	string	必須	Type の値に基づく、エンドポイントの IP アドレス、ドメイン名、またはインスタンス ID。	120.1.XX.XX
SubAddress	string	任意	ENI のプライベート IP アドレス。説明このパラメーターは、エンドポイントタイプが ENI に設定されている場合にのみ使用できます。このパラメーターを指定しない場合、ENI のプライマリプライベート IP アドレスが使用されます。	172.168.XX.XX
VpcId	string	任意	VPC の ID。スマートルーティングリスナーのエンドポイントグループには、最大 1 つの VPC ID を指定できます。説明このパラメーターは必須であり、エンドポイントタイプが IpTarget に設定されている場合にのみ有効です。	vpc-bp1quce3451z5b2hv****
VSwitchIds	array	任意	VPC 内の vSwitch のリスト。
	string	任意	vSwitch の ID。スマートルーティングリスナーのエンドポイントグループには、最大 2 つの vSwitch ID を指定できます。説明このパラメーターは必須であり、エンドポイントタイプが IpTarget に設定されている場合にのみ有効です。 vSwitch は VpcId パラメーターで指定された VPC に属している必要があります。	vsw-bp12mho4ze51ezagm****
EndpointRequestProtocol	string	任意	バックエンドサービスのプロトコル。有効値： HTTP (デフォルト) HTTPS 説明このパラメーターは、HTTP または HTTPS リスナーのエンドポイントグループを作成する場合にのみ設定できます。 HTTP リスナーの場合、バックエンドサービスのプロトコルは HTTP である必要があります。	HTTP
EndpointProtocolVersion	string	任意	バックエンドサービスプロトコルのバージョン。有効値： HTTP1.1 (デフォルト)：HTTP/1.1 HTTP2：HTTP/2 説明このパラメーターは、バックエンドサービスプロトコルが HTTPS に設定されている場合にのみ設定できます。	HTTP1.1
EndpointGroupType	string	任意	エンドポイントグループのタイプ。有効値： default (デフォルト)：デフォルトのエンドポイントグループ。 virtual：仮想エンドポイントグループ。説明レイヤー 4 リスナーの仮想エンドポイントグループを作成する場合は、デフォルトのエンドポイントグループが作成されていることを確認してください。	default
PortOverrides	array<object>	任意	ポートマッピング。
	object	任意	ポートマッピング。
ListenerPort	integer	任意	エンドポイントポートにマッピングされるリスナーポート。説明 TCP リスナーの場合、仮想エンドポイントグループはポートマッピングをサポートしていません。リスナーに対して仮想エンドポイントグループがすでに存在する場合、デフォルトのエンドポイントグループにポートマッピングを設定することはできません。デフォルトのエンドポイントグループにポートマッピングが設定されている場合、仮想エンドポイントグループを追加することはできません。ポートマッピングを設定した後、HTTP と HTTPS の切り替えを除き、リスナープロトコルを変更することはできません。リスナーポート範囲を変更する場合、新しい範囲には現在マッピングされているすべてのリスナーポートが含まれている必要があります。たとえば、現在のリスナーポート範囲が 80～82 で、ポート 80、81、82 のマッピングがある場合、リスナーポート範囲を 80～81 に変更することはできません。	443
EndpointPort	integer	任意	リスナーポートがマッピングされるエンドポイントポート。	80
HealthCheckEnabled	boolean	任意	ヘルスチェック機能を有効にするかどうかを指定します。有効値： true：ヘルスチェック機能を有効にします。 false：ヘルスチェック機能を無効にします。	true
Tag	array<object>	任意	エンドポイントグループのタグ。
	object	任意	エンドポイントグループのタグ。
Key	string	任意	エンドポイントグループのタグキー。タグキーは空の文字列にできません。タグキーは最大 64 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。最大 20 個のタグキーを指定できます。	test-key
Value	string	任意	エンドポイントグループのタグ値。タグ値は空の文字列にできます。タグ値は最大 128 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。最大 20 個のタグ値を指定できます。	test-value
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効値： true：ドライランを実行します。システムは、必須パラメーター、リクエスト形式、およびサービス制限を確認します。リクエストがドライランに失敗すると、エラーメッセージが返されます。リクエストがドライランに合格すると、システムは 2xx HTTP ステータスコードを返します。 false (デフォルト)：リクエストを送信します。リクエストがチェックに合格すると、2xx HTTP ステータスコードが返され、エンドポイントグループが作成されます。	false
HealthCheckHost	string	任意

レスポンスフィールド

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

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Domain.NotFit	The domain is not fit the rule
400	Resource.QuotaFull	The resource quota is exceeded.
400	NotExist.ListenerPort	The listening port %s does not exist.
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.
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	Exist.EndpointGroup	The endpoint group already exists.
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.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

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

変更履歴

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