CreateBasicEndpoints API による Basic GA インスタンスへのバッチエンドポイントプロビジョニング - GA - Alibaba Cloud - Global Accelerator

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

操作説明

CreateBasicEndpoints 操作は非同期です。システムはリクエスト ID を返しますが、エンドポイントのバッチ作成操作はまだ完了していません。バッチ作成タスクはバックグラウンドで実行中です。 ListBasicEndpoints 操作を呼び出して、エンドポイントのステータスをクエリできます。 - エンドポイントのステータスが init の場合、エンドポイントのバッチ作成タスクは完了していません。この状態では、クエリ操作のみ実行できます。 - すべてのエンドポイントのステータスが active の場合、エンドポイントのバッチ作成操作は完了しています。
CreateBasicEndpoints 操作では、同じベーシック 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:CreateBasicEndpoints

create

*BasicEndpoint。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	Global Accelerator インスタンスのリージョン ID。値を cn-hangzhou に設定します。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、異なるリクエスト間で値が一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみ使用できます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。各 API リクエストの RequestId は一意です。	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	必須	ベーシック Global Accelerator (GA) インスタンスの ID。	ga-bp17frjjh0udz4qz****
EndpointGroupId	string	必須	ベーシック Global Accelerator (GA) インスタンスに関連付けられているエンドポイントグループの ID。	epg-bp1dmlohjjz4kqaun****
Endpoints	array<object>	必須	ベーシック Global Accelerator (GA) インスタンスのエンドポイント。
	object	任意	ベーシック Global Accelerator (GA) インスタンスのエンドポイント。
EndpointAddress	string	任意	エンドポイントのアドレス。	eni-bp1a05txelswuj8g****
EndpointSubAddress	string	任意	エンドポイントのセカンダリアドレス。このパラメーターは、エンドポイントタイプが ECS、ENI、または NLB の場合に必須です。エンドポイントタイプが ECS の場合、EndpointSubAddress にはプライマリネットワークインターフェース (NIC) のセカンダリ非公開 IP を指定できます。このパラメーターを空にすると、プライマリ NIC のプライマリ非公開 IP が使用されます。エンドポイントタイプが ENI の場合、EndpointSubAddress にはセカンダリ NIC のセカンダリ非公開 IP を指定できます。このパラメーターを空にすると、セカンダリ NIC のプライマリ非公開 IP が使用されます。エンドポイントタイプが NLB の場合、このパラメーターは必須です。EndpointSubAddress は NLB バックエンドサーバーのプライマリ非公開 IP です。	172.16.XX.XX
EndpointSubAddressType	string	任意	エンドポイントのセカンダリアドレスのタイプ。有効な値: primary: エンドポイントのセカンダリアドレスはプライマリ非公開 IP アドレスです。 secondary: エンドポイントのセカンダリアドレスはセカンダリ非公開 IP アドレスです。このパラメーターは、エンドポイントタイプが ECS、ENI、または NLB の場合に必須です。エンドポイントタイプが NLB の場合、primary のみがサポートされます。	primary
EndpointType	string	任意	エンドポイントタイプ。有効な値: ENI: Alibaba Cloud エラスティックネットワークインターフェース (ENI)。 SLB: Classic Load Balancer (CLB) インスタンス。 ECS: Alibaba Cloud ECS インスタンス。 NLB: Network Load Balancer (NLB) インスタンス。説明このパラメーターは必須です。	ENI
EndpointZoneId	string	任意	エンドポイントのゾーン ID。このパラメーターは、エンドポイントタイプが NLB の場合にのみ必須です。	cn-hangzhou-g
Name	string	任意	ベーシック Global Accelerator (GA) インスタンスに関連付けられているエンドポイントの名前。名前は 1～128 文字で、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。先頭は英字または中国語の文字にする必要があります。	ep01

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
EndpointGroupId	string	ベーシック Global Accelerator (GA) インスタンスに関連付けられているエンドポイントグループの ID。	epg-bp1dmlohjjz4kqaun****
Endpoints	array<object>	ベーシック Global Accelerator (GA) インスタンスのエンドポイント。
	object	ベーシック Global Accelerator (GA) インスタンスのエンドポイント。
EndpointAddress	string	エンドポイントのアドレス。	eni-bp1a05txelswuj8g****
EndpointId	string	ベーシック Global Accelerator (GA) インスタンスに関連付けられているエンドポイントの ID。	ep-bp14sz7ftcwwjgrdm****
EndpointSubAddress	string	エンドポイントのセカンダリアドレス。このパラメーターは、エンドポイントタイプが ECS、ENI、または NLB の場合に返されます。エンドポイントタイプが ECS の場合、EndpointSubAddress はプライマリ NIC のセカンダリ非公開 IP またはプライマリ非公開 IP です。エンドポイントタイプが ENI の場合、EndpointSubAddress はセカンダリ NIC のセカンダリ非公開 IP またはプライマリ非公開 IP です。エンドポイントタイプが NLB の場合、EndpointSubAddress は NLB バックエンドサーバーのプライマリ非公開 IP です。	172.16.XX.XX
EndpointType	string	エンドポイントタイプ。有効な値: ENI: Alibaba Cloud エラスティックネットワークインターフェース (ENI)。 SLB: Classic Load Balancer (CLB) インスタンス。 ECS: Alibaba Cloud ECS インスタンス。 NLB: Network Load Balancer (NLB) インスタンス。	ENI
RequestId	string	リクエスト ID。	04F0F334-1335-436C-A1D7-6C044FE73368

例

成功レスポンス

JSONJSON

{
  "EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
  "Endpoints": [
    {
      "EndpointAddress": "eni-bp1a05txelswuj8g****",
      "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
      "EndpointSubAddress": "172.16.XX.XX",
      "EndpointType": "ENI"
    }
  ],
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	NotExist.Accelerator	The accelerated instance does not exist.	The accelerated instance does not exist.
400	NotFound.ENIInstance	The ENI instance is not found.
400	Invalidate.SlbAddressType	The SLB instance must be internal-facing.

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

変更履歴

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