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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetVpcEndpointAttribute

要执行的操作,取值:GetVpcEndpointAttribute

RegionId String eu-west-1

要获取属性信息的终端节点所属的地域ID。您可以通过调用DescribeRegions接口获取地域ID。

EndpointId String ep-hp33b2e43fays7s8****

要获取属性信息的终端节点。

返回数据

名称 类型 示例值 描述
Bandwidth Integer 1024

终端节点的连接带宽,单位为Mbps。

ConnectionStatus String Connected

终端节点连接状态:

  • Pending:修改中。
  • Connecting:连接中。
  • Connected:已连接。
  • Disconnecting:断开连接中。
  • Disconnected:未连接。
  • Deleting:删除中。
CreateTime String 2020-01-02T19:11:12Z

终端节点的创建时间。

EndpointBusinessStatus String Normal

终端节点的业务状态:

  • Normal:正常。
  • FinacialLocked:欠费锁定。
EndpointDescription String This is my Endpoint.

终端节点描述。

EndpointDomain String ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com

终端节点域名。

EndpointId String ep-hp33b2e43fays7s8****

终端节点ID。

EndpointName String test

终端节点名称。

EndpointStatus String Active

终端节点状态:

  • Creating:创建中。
  • Active:可用。
  • Pending:修改中。
  • Deleting:删除中。
Payer String Endpoint

付费方,取值:

  • Endpoint:服务使用方。
  • EndpointService:服务提供方。
RegionId String eu-west-1

终端节点所属的地域ID。

RequestId String 8D8992C1-6712-423C-BAC5-E5E817484C6B

请求ID。

ResourceOwner Boolean true

终端节点和终端节点服务是否同一账号,取值:

  • true:是。
  • false:否。
ServiceId String epsrv-hp3vpx8yqxblby3i****

终端节点关联的终端节点服务的ID。

ServiceName String com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****

终端节点关联的终端节点服务的名称。

VpcId String vpc-fdfhkjafhjvcvdjf****

终端节点所属的专有网络ID。

ZoneAffinityEnabled Boolean true

是否支持可用区就近解析,取值:

  • true:是。
  • false:否。

示例

请求示例

http(s)://[Endpoint]/?Action=GetVpcEndpointAttribute
&RegionId=eu-west-1
&<公共请求参数>

正常返回示例

XML格式

<GetVpcEndpointAttributeResponse>
  <Payer>Endpoint</Payer>
  <EndpointDomain>ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com</EndpointDomain>
  <RequestId>8D8992C1-6712-423C-BAC5-E5E817484C6B</RequestId>
  <CreateTime>2020-01-02T19:11:12Z</CreateTime>
  <ResourceOwner>true</ResourceOwner>
  <EndpointBusinessStatus>Normal</EndpointBusinessStatus>
  <EndpointDescription>This is my Endpoint.</EndpointDescription>
  <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>
  <EndpointStatus>Active</EndpointStatus>
  <VpcId>vpc-fdfhkjafhjvcvdjf****</VpcId>
  <EndpointName>test</EndpointName>
  <ServiceName>com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****</ServiceName>
  <Bandwidth>1024</Bandwidth>
  <EndpointId>ep-hp33b2e43fays7s8****</EndpointId>
  <RegionId>eu-west-1</RegionId>
  <ConnectionStatus>Connected</ConnectionStatus>
  <ZoneAffinityEnabled>true</ZoneAffinityEnabled>
</GetVpcEndpointAttributeResponse>

JSON格式

{
    "Payer": "Endpoint",
    "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
    "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
    "CreateTime": "2020-01-02T19:11:12Z",
    "ResourceOwner": true,
    "EndpointBusinessStatus": "Normal",
    "EndpointDescription": "This is my Endpoint.",
    "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
    "EndpointStatus": "Active",
    "VpcId": "vpc-fdfhkjafhjvcvdjf****",
    "EndpointName": "test",
    "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
    "Bandwidth": 1024,
    "EndpointId": "ep-hp33b2e43fays7s8****",
    "RegionId": "eu-west-1",
    "ConnectionStatus": "Connected",
    "ZoneAffinityEnabled": true
}

错误码

HttpCode 错误码 错误信息 描述
400 EndpointNotFound The specified Endpoint does not exist. 当前终端节点未找到。
400 EndpointConnectionNotFound The specified endpoint connection does not exist. 当前终端节点连接未找到。

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