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

调试

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

请求参数

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

系统规定参数。取值:GetVpcEndpointAttribute

RegionId String cn-huhehaote

获取属性信息的终端节点所属的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

EndpointId String ep-hp33b2e43fays7s8****

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

返回数据

名称 类型 示例值 描述
Payer String Endpoint

付费方。取值:

  • Endpoint:服务使用方。
  • EndpointService:服务提供方。
EndpointDomain String ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com

终端节点域名。

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

请求ID。

CreateTime String 2021-09-24T18:00:07Z

终端节点的创建时间。

ResourceOwner Boolean true

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

  • true:是。
  • false:否。
EndpointBusinessStatus String Normal

终端节点的业务状态。取值:

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

终端节点描述。

ServiceId String epsrv-hp3vpx8yqxblby3i****

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

EndpointStatus String Active

终端节点状态。取值:

  • Creating:创建中。
  • Active:可用。
  • Pending:修改中。
  • Deleting:删除中。
VpcId String vpc-fdfhkjafhjvcvdjf****

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

EndpointName String test

终端节点名称。

ZonePrivateIpAddressCount Long 1

每个可用区ENI的私网IP的数量。仅取值:1

EndpointType String Interface

终端节点类型。

取值:Interface,表示ServiceId的服务资源类型为CLB的终端节点服务。

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

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

Bandwidth Integer 1024

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

EndpointId String ep-hp33b2e43fays7s8****

终端节点ID。

RegionId String cn-huhehaote

终端节点所属的地域ID。

ConnectionStatus String Connected

终端节点连接状态。取值:

  • Pending:修改中。
  • Connecting:连接中。
  • Connected:已连接。
  • Disconnecting:断开连接中。
  • Disconnected:未连接。
  • Deleting:删除中。
ZoneAffinityEnabled Boolean true

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

  • true:是。
  • false:否。

示例

请求示例

http(s)://[Endpoint]/?Action=GetVpcEndpointAttribute
&EndpointId=ep-hp33b2e43fays7s8****
&RegionId=cn-huhehaote
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetVpcEndpointAttributeResponse>
    <Payer>Endpoint</Payer>
    <EndpointDomain>ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com</EndpointDomain>
    <RequestId>8D8992C1-6712-423C-BAC5-E5E817484C6B</RequestId>
    <CreateTime>2021-09-24T18:00:07Z</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>
    <ZonePrivateIpAddressCount>1</ZonePrivateIpAddressCount>
    <EndpointType>Interface</EndpointType>
    <ServiceName>com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****</ServiceName>
    <Bandwidth>1024</Bandwidth>
    <EndpointId>ep-hp33b2e43fays7s8****</EndpointId>
    <RegionId>cn-huhehaote</RegionId>
    <ConnectionStatus>Connected</ConnectionStatus>
    <ZoneAffinityEnabled>true</ZoneAffinityEnabled>
</GetVpcEndpointAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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
}

错误码

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

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