ListVpcEndpoints を使用して VPC エンドポイントを取得 - PrivateLink - Alibaba Cloud - PrivateLink

ListVpcEndpoints 操作は、エンドポイントの一覧を取得します。

今すぐお試しください

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

get

*VpcEndpoint

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	エンドポイントがデプロイされているリージョンの ID です。 DescribeRegions 操作を呼び出して、リージョン ID を取得できます。	cn-huhehaote
NextToken	string	任意	次のページの結果を取得するために使用するトークンです。初回クエリの場合、または次のページがない場合は、このパラメーターを指定する必要はありません。次のページがある場合は、前回の呼び出しから返された NextToken の値を設定します。	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	任意	1 ページあたりに返されるエントリ数です。有効値：1～1000。デフォルト値：50。	50
EndpointId	string	任意	エンドポイントの ID です。	ep-hp33b2e43fays7s8****
ServiceName	string	任意	エンドポイントが関連付けられているエンドポイントサービスの名前です。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
VpcId	string	任意	エンドポイントが属する VPC の ID です。	vpc-fdjkf789dfdfdfde****
EndpointName	string	任意	エンドポイントの名前です。	test
EndpointType	string	任意	エンドポイントのタイプです。有効値： Interface：インターフェイスエンドポイント Reverse：リバースエンドポイント GatewayLoadBalancer：Gateway Load Balancer タイプのエンドポイント	Interface
EndpointStatus	string	任意	エンドポイントのステータスです。有効値： Creating：エンドポイントを作成中です。 Active：エンドポイントは利用可能です。 Pending：エンドポイントを変更中です。 Deleting：エンドポイントを削除中です。	Active
ConnectionStatus	string	任意	エンドポイントの接続状態です。有効値： Pending：エンドポイント接続を変更中です。 Connecting：エンドポイントを接続中です。 Connected：エンドポイントは接続されています。 Disconnecting：エンドポイントを切断中です。 Disconnected：エンドポイントは切断されています。 Deleting：エンドポイントを削除中です。 ServiceDeleted：エンドポイントが関連付けられているエンドポイントサービスが削除されました。	Disconnected
Tag	array<object>	任意	タグです。
	object	任意	キーと値のペアで構成されるタグです。
Key	string	任意	タグキーです。最大 20 個のタグキーを指定できます。タグキーは空文字列にできません。タグキーの長さは最大 64 文字で、`aliyun` または `acs:` で開始できません。`http://` または `https://` を含めることはできません。	FinanceDept
Value	string	任意	タグ値です。最大 20 個のタグ値を指定できます。タグ値は空文字列にできます。タグ値の長さは最大 128 文字で、`aliyun` または `acs:` で開始できません。`http://` または `https://` を含めることはできません。	FinanceJoshua
RegionId	string	必須	エンドポイントがデプロイされているリージョンの ID です。 DescribeRegions 操作を呼び出して、リージョン ID を取得できます。	cn-huhehaote
ResourceGroupId	string	任意	リソースグループの ID です。	1
AddressIpVersion	string	任意	IP バージョンです。有効値： IPv4：IPv4 DualStack：デュアルスタック	IPv4
ServiceRegionId	string	任意	エンドポイントサービスがデプロイされているリージョンの ID です。	cn-huhehaote

レスポンスフィールド

フィールド	型	説明	例
	object
Endpoints	array<object>	エンドポイントのリストです。
	array<object>
VpcId	string	エンドポイントが属する VPC の ID です。	vpc-hp356stwkxg3fn2xe****
EndpointName	string	エンドポイントの名前です。	test
EndpointType	string	エンドポイントのタイプです。有効値： Interface：インターフェイスエンドポイント。 Reverse：リバースエンドポイント。 GatewayLoadBalancer：Gateway Load Balancer エンドポイント。	Interface
CreateTime	string	エンドポイントの作成時刻です。	2021-09-24T18:00:07Z
ServiceId	string	関連付けられたエンドポイントサービスの ID です。	epsrv-hp3vpx8yqxblby3i****
ZoneAffinityEnabled	boolean	ゾーン対応 DNS 解決が有効かどうかを示します。有効値： true false	true
EndpointDomain	string	エンドポイントのドメイン名です。	ep-hp33b2e43fays7s8**.epsrv-hp3xdsq46ael67lo**.cn-huhehaote.privatelink.aliyuncs.com
EndpointStatus	string	エンドポイントのステータスです。有効値： Creating：エンドポイントを作成中です。 Active：エンドポイントは利用可能です。 Pending：エンドポイントを変更中です。 Deleting：エンドポイントを削除中です。	Active
RegionId	string	エンドポイントが含まれるリージョンの ID です。	cn-huhehaote
ResourceOwner	boolean	エンドポイントとエンドポイントサービスが同じ Alibaba Cloud アカウントに属しているかどうかを示します。有効値： true false	true
Bandwidth	integer	エンドポイントの接続帯域幅 (単位：Mbps) です。	1024
ConnectionStatus	string	エンドポイントの接続ステータスです。有効値： Pending：接続を変更中です。 Connecting：エンドポイントを接続中です。 Connected：エンドポイントは接続されています。 Disconnecting：エンドポイントを切断中です。 Disconnected：エンドポイントは切断されています。 Deleting：エンドポイントを削除中です。 ServiceDeleted：関連付けられたエンドポイントサービスが削除されました。	Disconnected
EndpointDescription	string	エンドポイントの説明です。	This is my Endpoint.
EndpointId	string	エンドポイントの ID です。	ep-hp33b2e43fays7s8****
EndpointBusinessStatus	string	エンドポイントのビジネスステータスです。有効値： Normal：エンドポイントは正常に動作しています。 FinancialLocked：支払い遅延によりエンドポイントがロックされています。	Normal
ServiceName	string	関連付けられたエンドポイントサービスの名前です。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Tags	array<object>	タグのリストです。
	object
Key	string	タグキーです。	FinanceDept
Value	string	タグ値です。	FinanceJoshua
ResourceGroupId	string	リソースグループの ID です。	1
PolicyDocument	string	RAM アクセスポリシーです。ポリシー構文の詳細については、「RAM ポリシーの基本要素」をご参照ください。	{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"\",\n \"Principal\": \"\",\n \"Resource\": \"*\"\n }\n ]\n}
AddressIpVersion	string	IP アドレスファミリです。有効値： IPv4：IPv4。 DualStack：デュアルスタック。	IPv4
ServiceRegionId	string	関連付けられたエンドポイントサービスがデプロイされているリージョンの ID です。	cn-huhehaote
CrossRegionBandwidth	integer	クロスリージョン接続の帯域幅 (単位：Mbps) です。	1000
NextToken	string	次のページの結果を取得するためのトークンです。 NextToken が空の場合、次のページは存在しません。値が返された場合、次のリクエストでその値を使用して次のページの結果を取得します。	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	リクエスト ID です。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	1 ページあたりに返されるエントリ数です。	50
TotalCount	integer	クエリに一致するエントリの総数です。	12

例

成功レスポンス

JSONJSON

{
  "Endpoints": [
    {
      "VpcId": "vpc-hp356stwkxg3fn2xe****",
      "EndpointName": "test",
      "EndpointType": "Interface",
      "CreateTime": "2021-09-24T18:00:07Z",
      "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
      "ZoneAffinityEnabled": true,
      "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
      "EndpointStatus": "Active",
      "RegionId": "cn-huhehaote",
      "ResourceOwner": true,
      "Bandwidth": 1024,
      "ConnectionStatus": "Disconnected",
      "EndpointDescription": "This is my Endpoint.",
      "EndpointId": "ep-hp33b2e43fays7s8****",
      "EndpointBusinessStatus": "Normal",
      "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ],
      "ResourceGroupId": "1",
      "PolicyDocument": "{\\n  \\\"Version\\\": \\\"1\\\",\\n  \\\"Statement\\\": [\\n    {\\n      \\\"Effect\\\": \\\"Allow\\\",\\n      \\\"Action\\\": \\\"*\\\",\\n      \\\"Principal\\\": \\\"*\\\",\\n      \\\"Resource\\\": \\\"*\\\"\\n    }\\n  ]\\n}",
      "AddressIpVersion": "IPv4",
      "ServiceRegionId": "cn-huhehaote",
      "CrossRegionBandwidth": 1000
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12
}

エラーコード

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

変更履歴

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