Queries the details about a specified endpoint.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetVpcEndpointAttribute

The operation that you want to perform. Set the value to GetVpcEndpointAttribute.

RegionId String Yes cn-huhehaote

The region ID of the endpoint.

You can call the DescribeRegions operation to query the most recent region list.

EndpointId String Yes ep-hp33b2e43fays7s8****

The ID of the endpoint that you want to query.

Response parameters

Parameter Type Example Description
Payer String Endpoint

The payer. Valid values:

  • Endpoint: the service consumer
  • EndpointService: the service provider
EndpointDomain String ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com

The domain name of the endpoint.

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

The ID of the request.

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

The time when the endpoint was created.

ResourceOwner Boolean true

Indicates whether the endpoint and the endpoint service belong to the same Alibaba Cloud account. Valid values:

  • true: yes
  • false: no
EndpointBusinessStatus String Normal

The business status of the endpoint. Valid values:

  • Normal: normal
  • FinacialLocked: locked due to overdue payments
EndpointDescription String This is my Endpoint.

The description of the endpoint.

ServiceId String epsrv-hp3vpx8yqxblby3i****

The ID of the endpoint service with which the endpoint is associated.

EndpointStatus String Active

The status of the endpoint. Valid values:

  • Creating: being created
  • Active: available
  • Pending: being modified
  • Deleting: being deleted
VpcId String vpc-fdfhkjafhjvcvdjf****

The ID of the virtual private cloud (VPC) to which the endpoint belongs.

EndpointName String test

The name of the endpoint.

ZonePrivateIpAddressCount Long 1

The number of private IP addresses that can be used by an elastic network interface (ENI) in each zone. The value is set to 1.

EndpointType String Interface

The type of the endpoint.

The value is set to Interface, which indicates that the resource type of ServiceId is Classic Load Balancer (CLB).

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

The name of the endpoint service that is associated with the endpoint.

Bandwidth Integer 1024

The bandwidth of the endpoint connection. Unit: Mbit/s.

EndpointId String ep-hp33b2e43fays7s8****

The ID of the endpoint.

RegionId String cn-huhehaote

The region ID of the endpoint.

ConnectionStatus String Connected

The status of the endpoint connection. Valid values:

  • Pending: being modified
  • Connecting: connecting
  • Connected: connected
  • Disconnecting: disconnecting
  • Disconnected: disconnected
  • Deleting: being deleted
ZoneAffinityEnabled Boolean true

Indicates whether zone affinity is enabled. Valid values:

  • true: yes
  • false: no

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetVpcEndpointAttribute
&EndpointId=ep-hp33b2e43fays7s8****
&RegionId=cn-huhehaote
&<Common request parameters>

Sample success responses

XML format 

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 format 

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
}

Error codes

HttpCode Error code Error message Description
400 EndpointNotFound The specified Endpoint does not exist. The error message returned because the specified endpoint is not found.
400 EndpointConnectionNotFound The specified endpoint connection does not exist. The error message returned because the endpoint connection is not found.

For a list of error codes, visit the API Error Center.