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

ベーシック 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:ListBasicEndpoints

list

*BasicEndpoint

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	GA インスタンスがデプロイされているリージョンの ID。値を cn-hangzhou に設定します。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークンです。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-426655440000
EndpointGroupId	string	必須	照会するエンドポイントが属するエンドポイントグループの ID。	epg-bp1dmlohjjz4kqaun****
EndpointType	string	任意	照会するエンドポイントのタイプ。有効な値： ENI：Elastic Network Interface (ENI)。 SLB：Classic Load Balancer (CLB) インスタンス。 ECS：Elastic Compute Service (ECS) インスタンス。 NLB：Network Load Balancer (NLB) インスタンス。	ENI
EndpointId	string	任意	照会するエンドポイントの ID。	ep-bp14sz7ftcwwjgrdm****
Name	string	任意	照会するエンドポイントの名前。名前は長さが 1～128 文字で、文字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。先頭は文字である必要があります。	ep01
NextToken	string	任意	クエリの開始点を決定するトークン。有効な値：これが最初のクエリであるか、次のクエリを送信しない場合は、このパラメーターを無視します。次のクエリを送信する場合は、最後の呼び出しで返された NextToken の値を設定します。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	任意	各ページで返すエントリの数。有効な値：1～50。デフォルト値：10。	10

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターのリスト。
RequestId	string	リクエストの ID。	04F0F334-1335-436C-A1D7-6C044FE73368
TotalCount	string	返されたエントリの総数。	1
NextToken	string	クエリの開始点を決定するトークン。有効な値： NextToken が返されない場合、追加の結果がないことを示します。 NextToken の値が返された場合、その値は次のクエリの開始点を決定するトークンです。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	string	ページごとに返されるエントリの数。	10
Endpoints	array<object>	ベーシック GA インスタンスに関連付けられているエンドポイント。
	object	ベーシック GA インスタンスに関連付けられているエンドポイント。
AcceleratorId	string	ベーシック GA インスタンスの ID。	ga-bp17frjjh0udz4qz****
EndpointGroupId	string	エンドポイントが属するエンドポイントグループの ID。	epg-bp1dmlohjjz4kqaun****
EndpointId	string	ベーシック GA インスタンスに関連付けられているエンドポイントの ID。	ep-bp14sz7ftcwwjgrdm****
Name	string	エンドポイントの名前。	ep01
EndpointType	string	エンドポイントのタイプ。有効な値： ENI：ENI。 SLB：CLB インスタンス。 ECS：ECS インスタンス。 NLB：NLB インスタンス。	ENI
EndpointAddress	string	エンドポイントのアドレス。	eni-bp1a05txelswuj8g****
EndpointSubAddress	string	エンドポイントのセカンダリアドレス。このパラメーターは、エンドポイントタイプが ECS、ENI、または NLB の場合に返されます。エンドポイントタイプが ECS の場合、EndpointSubAddress はプライマリ ENI のプライマリまたはセカンダリプライベート IP アドレスを返します。エンドポイントタイプが ENI の場合、EndpointSubAddress はセカンダリ ENI のプライマリまたはセカンダリプライベート IP アドレスを返します。エンドポイントタイプが NLB の場合、EndpointSubAddress は NLB バックエンドサーバーのプライマリプライベート IP アドレスを返します。	172.16.XX.XX
EndpointSubAddressType	string	エンドポイントのセカンダリアドレスタイプ。 primary：プライマリプライベート IP アドレス。 secondary：セカンダリプライベート IP アドレス。このパラメーターは、エンドポイントのタイプが ECS、ENI、または NLB に設定されている場合に返されます。エンドポイントタイプが NLB に設定されている場合は、primary が返されます。	primary
EndpointZoneId	string	エンドポイントのゾーン ID。このパラメーターは、エンドポイントタイプが NLB に設定されている場合にのみ返されます。	cn-hangzhou-g
State	string	エンドポイントのステータス。有効な値： init：エンドポイントは初期化中です。 active：エンドポイントは利用可能です。 updating：エンドポイントは設定中です。 binding：エンドポイントは関連付け中です。 unbinding：エンドポイントは関連付け解除中です。 deleting：エンドポイントは削除中です。 bound：エンドポイントは関連付け済みです。	active

例

成功レスポンス

JSONJSON

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": "1",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": "10",
  "Endpoints": [
    {
      "AcceleratorId": "ga-bp17frjjh0udz4qz****",
      "EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
      "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
      "Name": "ep01",
      "EndpointType": "ENI",
      "EndpointAddress": "eni-bp1a05txelswuj8g****",
      "EndpointSubAddress": "172.16.XX.XX",
      "EndpointSubAddressType": "primary",
      "EndpointZoneId": "cn-hangzhou-g",
      "State": "active"
    }
  ]
}

エラーコード

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

変更履歴

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