GetVpcEndpointAttribute を使用して 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:GetVpcEndpointAttribute

get

*VpcEndpoint

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	属性をクエリするエンドポイントのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-huhehaote
EndpointId	string	必須	属性を照会するエンドポイントの ID。	ep-hp33b2e43fays7s8****

レスポンスフィールド

フィールド	型	説明	例
	object
Payer	string	支払者。有効な値: Endpoint: サービス利用者。 EndpointService: サービスプロバイダー。	Endpoint
EndpointDomain	string	エンドポイントのドメイン名。	ep-hp33b2e43fays7s8**.epsrv-hp3xdsq46ael67lo**.cn-huhehaote.privatelink.aliyuncs.com
RequestId	string	リクエスト ID。	8D8992C1-6712-423C-BAC5-E5E817484C6B
CreateTime	string	エンドポイントが作成された時間。	2021-09-24T18:00:07Z
ResourceOwner	boolean	エンドポイントとエンドポイントサービスが同じ Alibaba Cloud アカウントに属しているかどうかを示します。有効な値: true: エンドポイントとエンドポイントサービスは同じアカウントに属しています。 false: エンドポイントとエンドポイントサービスは異なるアカウントに属しています。	true
EndpointBusinessStatus	string	エンドポイントのビジネスステータス。有効な値: Normal: 法線。 FinancialLocked: 滞納ロック。	Normal
EndpointDescription	string	エンドポイントの説明。	This is my Endpoint
ServiceId	string	エンドポイントが関連付けられているエンドポイントサービスの ID。	epsrv-hp3vpx8yqxblby3i****
EndpointStatus	string	エンドポイントのステータス。有効な値: Creating: 作成中。 Active: 利用可能。 Pending: 変更済み。 Deleting: 削除中。	Active
VpcId	string	エンドポイントが属する仮想プライベートクラウド (VPC) の ID。	vpc-fdfhkjafhjvcvdjf****
EndpointName	string	エンドポイントの名前。	test
ZonePrivateIpAddressCount	integer	各ゾーンでエンドポイントの Elastic ネットワークインターフェース (ENI) に割り当てられた非公開 IP アドレスの数。値は 1 に固定されています。	1
EndpointType	string	エンドポイントタイプ。有効な値: Interface: インターフェイスエンドポイント。 Reverse: リバースエンドポイント。 GatewayLoadBalancer: Gateway Load Balancer エンドポイント (GWLBe)。	Interface
ServiceName	string	エンドポイントが関連付けられているエンドポイントサービスの名前。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Bandwidth	integer	エンドポイント接続の帯域幅。単位: Mbps。	1024
EndpointId	string	エンドポイント ID。	ep-hp33b2e43fays7s8****
RegionId	string	エンドポイントのリージョン ID。	cn-huhehaote
ConnectionStatus	string	エンドポイント接続のステータス。有効な値: Pending: 変更済み。 Connecting: 接続中。 Connected: 接続済み。 Disconnecting: 切断中。 Disconnected: 切断済み。 Deleting: 削除中。 ServiceDeleted: 対応するエンドポイントサービスが削除されました。	Connected
ZoneAffinityEnabled	boolean	エンドポイントのドメイン名が接続先のサービスに解決される際に、ゾーンアフィニティが有効かどうかを示します。有効な値: true: 有効。 false: 無効。	true
ResourceGroupId	string	リソースグループ ID。	rg-acfmz7nocpei***
PolicyDocument	string	RAM アクセスポリシー。ポリシー解像度の詳細については、「ポリシー要素」を参照してください。	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": [ "oss:List", "oss:PutObject", "oss:GetObject" ], "Resource": [ "acs:oss:oss-::pvl-policy-test/policy-test.txt" ], "Principal": { "RAM": [ "acs:ram::14199xxxxxx:" ] } } ] }
AddressIpVersion	string	プロトコルバージョン。有効な値: IPv4: IPv4。 DualStack: デュアルスタック。	IPv4
ServiceRegionId	string	エンドポイントが関連付けられているエンドポイントサービスのリージョン ID。	cn-hangzhou
CrossRegionBandwidth	integer	エンドポイントのクロスリージョン帯域幅。単位: Mbps。	1000
ProtectedEnabled	boolean	マネージド保護が有効かどうかを示します。このパラメーターは STS 呼び出しメソッドを使用した場合にのみ効果があります。有効な値: true: 有効。マネージド保護を有効にすると、エンドポイントを作成したユーザーのみが STS を使用してエンドポイントを変更または削除できます。 false: 無効。

例

成功レスポンス

JSONJSON

{
  "Payer": "Endpoint",
  "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "CreateTime": "2021-09-24T18:00:07Z",
  "ResourceOwner": true,
  "EndpointBusinessStatus": "Normal",
  "EndpointDescription": "This is my Endpoint",
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "EndpointStatus": "Active",
  "VpcId": "vpc-fdfhkjafhjvcvdjf****",
  "EndpointName": "test",
  "ZonePrivateIpAddressCount": 1,
  "EndpointType": "Interface",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
  "Bandwidth": 1024,
  "EndpointId": "ep-hp33b2e43fays7s8****",
  "RegionId": "cn-huhehaote",
  "ConnectionStatus": "Connected",
  "ZoneAffinityEnabled": true,
  "ResourceGroupId": "rg-acfmz7nocpei***",
  "PolicyDocument": "{\n  \"Version\": \"1\",\n  \"Statement\": [\n    {\n      \"Effect\": \"Allow\",\n      \"Action\": [\n        \"oss:List*\",\n        \"oss:PutObject\",\n        \"oss:GetObject\"\n      ],\n      \"Resource\": [\n        \"acs:oss:oss-*:*:pvl-policy-test/policy-test.txt\"\n      ],\n      \"Principal\": {\n        \"RAM\": [\n          \"acs:ram::14199xxxxxx:*\"\n        ]\n      }\n    }\n  ]\n}",
  "AddressIpVersion": "IPv4",
  "ServiceRegionId": "cn-hangzhou",
  "CrossRegionBandwidth": 1000,
  "ProtectedEnabled": false
}

エラーコード

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

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

変更履歴

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