ListVpcEndpointZones を使用して VPC エンドポイントゾーンをクエリ - PrivateLink

ListVpcEndpointZones 操作を呼び出して、エンドポイントのゾーンをクエリします。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

privatelink:ListVpcEndpointZones

get

*VpcEndpoint

acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 DescribeRegions 操作を呼び出してリージョン ID を取得します。	cn-huhehaote
NextToken	string	任意	次のページの結果を取得するために使用されるトークン。有効な値は次のとおりです。最初のクエリの場合、このパラメーターを指定する必要はありません。次のページが存在する場合、このパラメーターの値を、前の呼び出しで返された NextToken 値に設定します。	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	任意	各ページで返すエントリ数。有効な値：1～1000。デフォルト値：50。	50
EndpointId	string	必須	エンドポイントの ID。エンドポイント ID を指定すると、システムはエンドポイントのゾーンをクエリします。	ep-hp33b2e43fays7s8****
RegionId	string	必須	リージョン ID。 DescribeRegions 操作を呼び出してリージョン ID を取得します。	cn-huhehaote

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	次のページの結果を取得するために使用されるトークン。有効な値は次のとおりです。このパラメーターが空の場合、次のページはありません。値が返された場合は、その値を使用して次のページの結果を取得します。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	リクエスト ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	各ページで返されるエントリ数。	50
TotalCount	integer	返されたエントリの総数。	12
Zones	array<object>	ゾーン情報のコレクション。
	object	ゾーンに関する情報。
VSwitchId	string	ゾーン内の vSwitch。システムは vSwitch 内にエンドポイント ENI を自動的に作成します。	vsw-hjkshjvdkdvd****
EniIp	string	エンドポイント ENI の IP アドレス。	192.168.2.23
ZoneStatus	string	ゾーンのステータス。有効な値は次のとおりです。 Creating：ゾーンは作成中です。 Wait：ゾーンは接続を待機しています。 Connected：ゾーンは接続されています。 Deleting：ゾーンは削除中です。 Disconnecting：ゾーンは切断中です。 Disconnected：ゾーンは切断されています。 Connecting：ゾーンは接続中です。	Wait
ZoneId	string	ゾーン ID。	cn-huhehaote-a
EniId	string	エンドポイント ENI の ID。	eni-hp3c8qj1tyct8aqy****
ZoneDomain	string	ゾーンのドメイン名。エンドポイント接続が確立された後、このドメイン名を使用してエンドポイントサービスのサービスリソースにアクセスします。	ep-hp3f033dp24c5yc9**-cn-huhehaote-a.epsrv-hp3itcpowf37m3d5**.cn-huhehaote.privatelink.aliyuncs.com
RegionId	string	エンドポイントがデプロイされているリージョンの ID。	cn-huhehaote
ZoneIpv6Address	string	エンドポイント ENI の IPv6 アドレス。	2408:4005:3b6:**:6955:c3cb:34c:**

例

成功レスポンス

JSONJSON

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12,
  "Zones": [
    {
      "VSwitchId": "vsw-hjkshjvdkdvd****",
      "EniIp": "192.168.2.23",
      "ZoneStatus": "Wait",
      "ZoneId": "cn-huhehaote-a",
      "EniId": "eni-hp3c8qj1tyct8aqy****",
      "ZoneDomain": "ep-hp3f033dp24c5yc9****-cn-huhehaote-a.epsrv-hp3itcpowf37m3d5****.cn-huhehaote.privatelink.aliyuncs.com",
      "RegionId": "cn-huhehaote",
      "ZoneIpv6Address": "2408:4005:3b6:****:6955:c3cb:34c:****\n"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	EndpointNotFound	The specified Endpoint does not exist.

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

変更履歴

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