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

ベーシック Global Accelerator (GA) インスタンスのエンドポイントグループを作成します。

操作説明

CreateBasicEndpointGroup は非同期操作です。リクエストの送信後、システムはエンドポイントグループ ID を返し、タスクをバックグラウンドで実行します。GetBasicEndpointGroup 操作を呼び出して、タスクのステータスをクエリできます。
- エンドポイントグループのステータスが init の場合、エンドポイントは作成中です。この場合、クエリ操作のみを実行できます。
- エンドポイントグループのステータスが active の場合、エンドポイントグループは作成済みです。
前のリクエストが完了する前に、同じ GA インスタンスで CreateBasicEndpointGroup 操作を再度呼び出すことはできません。

今すぐお試しください

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

create

*BasicEndpointGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	GA インスタンスが配置されているリージョン ID。値を cn-hangzhou に設定します。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークンです。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	必須	ベーシック GA インスタンスの ID。	ga-bp17frjjh0udz4qz****
EndpointGroupRegion	string	必須	エンドポイントグループが属するリージョンの ID。 ListAvailableBusiRegions 操作を呼び出してリージョン ID を照会できます。	cn-shanghai
Name	string	任意	エンドポイントグループの名前。名前の長さは 2～128 文字で、英字、数字、アンダースコア (_)、ハイフン (-) を使用できます。名前は英字で始める必要があります。	group1
Description	string	任意	エンドポイントグループの説明。説明は最大 200 文字で、`http://` または `https://` で始めることはできません。	BasicEndpointGroup
EndpointType	string	任意	エンドポイントのタイプ。有効な値： ENI SLB ECS	ENI
EndpointAddress	string	任意	エンドポイントアドレス。	eni-bp1a05txelswuj8g****
EndpointSubAddress	string	任意	エンドポイントのセカンダリアドレス。アクセラレーション IP アドレスが Elastic Compute Service (ECS) インスタンスまたは Elastic Network Interface (ENI) のセカンダリプライベート IP アドレスに関連付けられている場合に、このパラメーターを指定する必要があります。エンドポイントタイプが ECS の場合、EndpointSubAddress をプライマリ ENI のセカンダリプライベート IP アドレスに設定できます。このパラメーターを空のままにすると、プライマリ ENI のプライマリプライベート IP アドレスが使用されます。エンドポイントタイプが ENI の場合、EndpointSubAddress をセカンダリ ENI のセカンダリプライベート IP アドレスに設定できます。このパラメーターを空のままにすると、セカンダリ ENI のプライマリプライベート IP アドレスが使用されます。	172.16.XX.XX

レスポンスフィールド

フィールド	型	説明	例
	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	Resource.QuotaFull	The resource quota is exceeded.
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.
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	Exist.EndpointGroup	The endpoint group already exists.
400	QuotaExceeded.EndpointGroup	The number of endpoint group exceeds the limit.
400	EcsCannotBind.BasicEndpoint	The ECS instance has already been associated with another EIP.
400	InvalidateRegion.BasicAccelerator	The region of the endpoint group and the acceleration region cannot be the same.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

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

変更履歴

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