调用GetVpcEndpointAttribute获取终端节点属性-私网连接-阿里云

调用GetVpcEndpointAttribute接口，获取终端节点属性信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

privatelink:GetVpcEndpointAttribute

get

*VpcEndpoint

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

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	获取属性信息的终端节点所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-huhehaote
EndpointId	string	是	获取属性信息的终端节点 ID。	ep-hp33b2e43fays7s8****
RegionId	string	是	获取属性信息的终端节点所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-huhehaote

返回参数

名称	类型	描述	示例值
	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	终端节点和终端节点服务是否同一账号。取值： 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	终端节点所属的专有网络 ID。	vpc-fdfhkjafhjvcvdjf****
EndpointName	string	终端节点名称。	test
ZonePrivateIpAddressCount	integer	每个可用区 ENI 的私网 IP 的数量。仅取值：1。	1
EndpointType	string	终端节点类型。取值： Interface：表示接口终端节点。 Reverse：表示反向终端节点。 GatewayLoadBalancer：表示网关型负载均衡终端节点。	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
CrossRegionBandwidth	integer

示例

正常返回示例

JSON格式

{
  "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 status code	错误码	错误信息	描述
400	EndpointNotFound	The specified Endpoint does not exist.	当前终端节点未找到。
400	EndpointConnectionNotFound	The specified endpoint connection does not exist.	当前终端节点连接未找到。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。