ListVpcEndpointConnections API の説明 - PrivateLink - Alibaba Cloud - PrivateLink

ListVpcEndpointConnections操作を呼び出して、エンドポイント接続を照会します。

今すぐお試しください

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

list

*VpcEndpointService

acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	照会するエンドポイント接続のリージョンID。 DescribeRegions 操作を呼び出してリージョンIDを照会できます。	cn-huhehaote
NextToken	string	任意	次のクエリに使用されるトークン。有効な値: 最初のクエリの場合、または次のクエリを送信しない場合は、このパラメーターを指定する必要はありません。次のクエリを送信する場合は、最後のAPI 呼び出しから返されたNextTokenの値に設定します。	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	任意	1ページあたりのエントリ数。有効な値: 1から1000。デフォルト値: 50。	50
ServiceId	string	任意	エンドポイントサービスID。	epsrv-hp3vpx8yqxblby3i****
EniId	string	任意	エンドポイントのElastic Network Interface (ENI) ID。	eni-hp32lk0pyv6o94hs****
EndpointId	string	任意	エンドポイントID。	ep-hp33b2e43fays7s8****
ConnectionStatus	string	任意	エンドポイント接続の状態。有効な値: Pending: エンドポイント接続を変更中です。 Connecting: エンドポイント接続を確立中です。 Connected: エンドポイントがエンドポイントサービスに接続されています。 Disconnecting: エンドポイントをエンドポイントサービスから切断中です。 Disconnected: エンドポイントがエンドポイントサービスから切断されています。 Deleting: エンドポイント接続を削除中です。 ServiceDeleted: 対応するエンドポイントサービスが削除されています。	Disconnected
EndpointOwnerId	integer	任意	エンドポイントが属するAlibaba CloudアカウントのID。	25346073170691****
ResourceId	string	任意	サービスリソースID。	lb-hp32z1wp5peaoox2q****
ReplacedResourceId	string	任意	スムーズなマイグレーションシナリオで置き換えられるサービスリソースのID。	lb-hp32z1wp5peaoox2q****
RegionId	string	必須	照会するエンドポイント接続のリージョンID。 DescribeRegions 操作を呼び出してリージョンIDを照会できます。	cn-huhehaote
ResourceGroupId	string	任意	エンドポイントが属するリソースグループのID。	rg-acfmy*****

レスポンスフィールド

フィールド	型	説明	例
	object
Connections	array<object>	エンドポイント接続に関する情報。
	array<object>	エンドポイント接続に関する情報。
Zones	array<object>	ゾーン情報。
	object	ゾーン情報。
VSwitchId	string	エンドポイントが属する vSwitch の ID です。	vsw-hp3uf6045ljdhd5zr****
ZoneId	string	ゾーンの ID です。	cn-huhehaote-b
ResourceId	string	サービスリソースの ID です。	lb-hp32z1wp5peaoox2q****
EniId	string	エンドポイント ENI の ID です。	eni-hp32lk0pyv6o94hs****
ZoneDomain	string	ゾーンのドメイン名です。	ep-hp34jaz8ykl0exwt**-cn-huhehaote.epsrv-hp3vpx8yqxblby3i**.cn-huhehaote-b.privatelink.aliyuncs.com
ZoneStatus	string	ゾーンのステータスです。有効値： Creating：ゾーンが作成中です。 Wait：エンドポイントが接続待ち状態です。 Connected：接続が確立されています。 Deleting：ゾーンが削除中です。 Disconnecting：接続が終了中です。 Disconnected：接続が終了しています。 Connecting：接続が確立中です。 Migrating：ゾーンが移行中です。 Migrated：ゾーンの移行が完了しています。	Connected
ReplacedResourceId	string	スムーズな移行中に置き換えられるサービスリソースの ID です。	lb-hp32z1wp5peaoox2q****
ReplacedEniId	string	スムーズな移行中に置き換えられるエンドポイント ENI の ID です。	eni-hp32lk0pyv6o94hs****
ModifiedTime	string	接続が変更された時刻。	2021-09-28T10:34:46Z
Bandwidth	integer	エンドポイント接続の帯域幅。単位: Mbit/s。	3072
EndpointOwnerId	integer	エンドポイントが属するAlibaba CloudアカウントのID。	25346073170691****
ResourceOwner	boolean	エンドポイントとエンドポイントサービスが同じAlibaba Cloudアカウントに属しているかどうかを示します。有効な値: true false	true
ServiceId	string	エンドポイントサービスID。	epsrv-hp3vpx8yqxblby3i****
ConnectionStatus	string	エンドポイント接続の状態。有効な値: Pending: エンドポイント接続を変更中です。 Connecting: エンドポイント接続を確立中です。 Connected: エンドポイントがエンドポイントサービスに接続されています。 Disconnecting: エンドポイントをエンドポイントサービスから切断中です。 Disconnected: エンドポイントがエンドポイントサービスから切断されています。 Deleting: エンドポイント接続を削除中です。 ServiceDeleted: 対応するエンドポイントサービスが削除されています。	Disconnected
EndpointId	string	エンドポイントID。	ep-hp33b2e43fays7s8****
EndpointVpcId	string	エンドポイントが属する仮想プライベートクラウド (VPC) のID。	vpc-hp356stwkxg3fn2xe****
ResourceGroupId	string	エンドポイントが属するリソースグループのID。	rg-acfmw353z35v***
TrafficControlMode	string	Scalability: 自動スケーリング。このモードでは、エンドポイント接続に設定された帯域幅は有効になりません。 BandwidthLimit: エンドポイント接続の帯域幅制限。帯域幅制限はBandwidthの値です。	BandwidthLimit
EndpointRegionId	string	エンドポイントのリージョンID。	cn-hangzhou
ServiceRegionId	string	エンドポイントサービスのリージョンID。	cn-huhehaote
NextToken	string	次のクエリに使用されるトークン。有効な値: NextTokenが空の場合、次のクエリは送信されません。 NextTokenの値が返された場合、その値が次のクエリに使用されるトークンです。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	リクエストID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	1ページあたりのエントリ数。	50
TotalCount	string	エンドポイント接続リストで返されたエントリ数。	1

例

成功レスポンス

JSONJSON

{
  "Connections": [
    {
      "Zones": [
        {
          "VSwitchId": "vsw-hp3uf6045ljdhd5zr****",
          "ZoneId": "cn-huhehaote-b",
          "ResourceId": "lb-hp32z1wp5peaoox2q****",
          "EniId": "eni-hp32lk0pyv6o94hs****",
          "ZoneDomain": "ep-hp34jaz8ykl0exwt****-cn-huhehaote.epsrv-hp3vpx8yqxblby3i****.cn-huhehaote-b.privatelink.aliyuncs.com",
          "ZoneStatus": "Connected",
          "ReplacedResourceId": "lb-hp32z1wp5peaoox2q****",
          "ReplacedEniId": "eni-hp32lk0pyv6o94hs****"
        }
      ],
      "ModifiedTime": "2021-09-28T10:34:46Z",
      "Bandwidth": 3072,
      "EndpointOwnerId": 0,
      "ResourceOwner": true,
      "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
      "ConnectionStatus": "Disconnected",
      "EndpointId": "ep-hp33b2e43fays7s8****",
      "EndpointVpcId": "vpc-hp356stwkxg3fn2xe****",
      "ResourceGroupId": "rg-acfmw353z35v***",
      "TrafficControlMode": "BandwidthLimit",
      "EndpointRegionId": "cn-hangzhou",
      "ServiceRegionId": "cn-huhehaote"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": "1"
}

エラーコード

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

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

変更履歴

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