GetBasicEndpointGroup API リファレンスとエンドポイントグループ属性 - GA

基本 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:GetBasicEndpointGroup

get

*BasicEndpointGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	基本 GA インスタンスがデプロイされているリージョンの ID。値を cn-hangzhou に設定します。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-426655440000
EndpointGroupId	string	必須	エンドポイントグループの ID。	epg-bp1dmlohjjz4kqaun****

レスポンスフィールド

フィールド	型	説明	例
	object	返された情報。
RequestId	string	リクエストの ID。	04F0F334-1335-436C-A1D7-6C044FE73368
AcceleratorId	string	基本 GA インスタンスの ID。	ga-bp17frjjh0udz4qz****
EndpointGroupId	string	エンドポイントグループの ID。	epg-bp1dmlohjjz4kqaun****
Name	string	エンドポイントグループの名前。	group1
Description	string	エンドポイントグループの説明。	BasicEndpointGroup
EndpointGroupRegion	string	エンドポイントグループが存在するリージョンの ID。	cn-shanghai
EndpointType	string	エンドポイントのタイプ。有効な値： ENI：エラスティックネットワークインターフェース (ENI)。 SLB：Classic Load Balancer (CLB) インスタンス。 ECS：Elastic Compute Service (ECS) インスタンス。 NLB：Network Load Balancer (NLB) インスタンス	ENI
EndpointAddress	string	エンドポイントのアドレス。	eni-bp1a05txelswuj8g****
State	string	エンドポイントグループのステータス。有効な値： init：初期化中。 active：正常に実行中。 updating：更新中。 deleting：削除中。	active
EndpointSubAddress	string	エンドポイントのセカンダリアドレス。このパラメーターは、エンドポイントタイプが ECS、ENI、または NLB の場合に返されます。エンドポイントタイプが ECS の場合、EndpointSubAddress はプライマリ ENI のプライマリまたはセカンダリプライベート IP アドレスを返します。エンドポイントタイプが ENI の場合、EndpointSubAddress はセカンダリ ENI のプライマリまたはセカンダリプライベート IP アドレスを返します。エンドポイントタイプが NLB の場合、EndpointSubAddress は NLB バックエンドサーバーのプライマリプライベート IP アドレスを返します。	172.16.XX.XX

例

成功レスポンス

JSONJSON

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "AcceleratorId": "ga-bp17frjjh0udz4qz****",
  "EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
  "Name": "group1",
  "Description": "BasicEndpointGroup",
  "EndpointGroupRegion": "cn-shanghai",
  "EndpointType": "ENI",
  "EndpointAddress": "eni-bp1a05txelswuj8g****",
  "State": "active",
  "EndpointSubAddress": "172.16.XX.XX"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

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

変更履歴

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