指定されたエンドポイントの属性を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
privatelink:GetVpcEndpointAttribute |
get |
*VpcEndpoint
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
エンドポイントが配置されているリージョンの ID です。 DescribeRegions 操作を呼び出すことで、リージョン ID を取得できます。 |
cn-huhehaote |
| EndpointId |
string |
必須 |
エンドポイントの ID です。 |
ep-hp33b2e43fays7s8**** |
| RegionId |
string |
必須 |
エンドポイントが配置されているリージョンの ID です。 DescribeRegions 操作を呼び出すことで、リージョン ID を取得できます。 |
cn-huhehaote |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| Payer |
string |
支払者。有効な値：
|
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 |
| EndpointBusinessStatus |
string |
エンドポイントのビジネスステータス。有効な値：
|
Normal |
| EndpointDescription |
string |
エンドポイントの説明です。 |
This is my Endpoint. |
| ServiceId |
string |
エンドポイントが関連付けられているエンドポイントサービスの ID です。 |
epsrv-hp3vpx8yqxblby3i**** |
| EndpointStatus |
string |
エンドポイントのステータス。有効な値：
|
Active |
| VpcId |
string |
エンドポイントが属する VPC の ID です。 |
vpc-fdfhkjafhjvcvdjf**** |
| EndpointName |
string |
エンドポイントの名前です。 |
test |
| ZonePrivateIpAddressCount |
integer |
各ゾーンにおける ENI のプライベート IP アドレスの数。値は常に 1 です。 |
1 |
| EndpointType |
string |
エンドポイントのタイプ。有効な値：
|
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 |
エンドポイント接続のステータス。有効な値：
|
Connected |
| ZoneAffinityEnabled |
boolean |
エンドポイントサービスのドメイン名が、最も近いゾーンのエンドポイントの IP アドレスに解決されるかどうかを示します。有効な値：
|
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 |
IP アドレスのバージョン。有効な値：
|
IPv4 |
| ServiceRegionId |
string |
||
| CrossRegionBandwidth |
integer |
例
成功レスポンス
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": "",
"CrossRegionBandwidth": 0
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | EndpointNotFound | The specified Endpoint does not exist. | |
| 400 | EndpointConnectionNotFound | The specified endpoint connection does not exist. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。