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

エンドポイントのリストを照会します。

今すぐお試しください

この 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	任意	次のクエリのトークンを指定するかどうかを指定します。有効な値: これが最初のクエリであるか、次のクエリがない場合、このパラメーターを指定する必要はありません。次のクエリが存在する場合、前の API 呼び出しで返された NextToken の値を設定します。	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	任意	ページあたりのエントリ数。有効な値: 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: ゲートウェイロードバランサーエンドポイント (GWLBe)。ゲートウェイロードバランサーエンドポイント (GWLBe) を作成して、負荷分散のためにゲートウェイロードバランサー (GWLB) に接続できます。	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
ResourceGroupId	string	任意	リソースグループの ID。	1
AddressIpVersion	string	任意	プロトコルバージョン。有効な値: 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: ゲートウェイロードバランサーエンドポイント (GWLBe)。ゲートウェイロードバランサーエンドポイント (GWLBe) を作成して、負荷分散のためにゲートウェイロードバランサー (GWLB) に接続できます。	Interface
CreateTime	string	エンドポイントが作成された時間。	2021-09-24T18:00:07Z
ServiceId	string	エンドポイントに関連付けられているエンドポイントサービスの ID。	epsrv-hp3vpx8yqxblby3i****
ZoneAffinityEnabled	boolean	エンドポイントのドメイン名が接続先のサービスに解決される際にゾーンアフィニティが有効になっているかどうかを示します。有効な値: 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	エンドポイントとエンドポイントサービスが同じアカウントに属しているかどうかを示します。有効な値: true: 同じアカウント。 false: 異なるアカウント。	true
Bandwidth	integer	エンドポイントの接続帯域幅。単位: Mbit/s。	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 アクセスポリシー。ポリシー定義の詳細については、「権限ポリシーの基本要素」をご参照ください。	{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"\",\n \"Principal\": \"\",\n \"Resource\": \"*\"\n }\n ]\n}
AddressIpVersion	string	プロトコルバージョン。有効な値: IPv4: IPv4。 DualStack: デュアルスタック。	IPv4
ServiceRegionId	string	エンドポイントに関連付けられているエンドポイントサービスのリージョン ID。	cn-huhehaote
CrossRegionBandwidth	integer	エンドポイントのクロスリージョン帯域幅。単位: Mbit/s。	1000
ProtectedEnabled	boolean	マネージド保護が有効かどうかを指定します。このパラメーターは STS ベースの呼び出しに対してのみ効果があります。有効な値: true: 有効。マネージド保護を有効にすると、エンドポイントを作成したユーザーのみが STS を通じてエンドポイントを変更または削除できます。 false: 無効。
NextToken	string	次のクエリが存在するかどうかを示します。有効な値: NextToken が空の場合、次のクエリは存在しません。 NextToken が返された場合、その値は次のクエリのトークンを示します。	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	リクエスト ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	ページあたりのエントリ数。	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,
      "ProtectedEnabled": false
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12
}

エラーコード

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

変更履歴

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