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.

EndpointId String Yes ep-hp33b2e43fays7s8****

The ID of the endpoint that you want to query.

RegionId String Yes eu-west-1

The region ID of the endpoint. You can call the DescribeRegions operation to query the most recent region list.

Response parameters

Parameter Type Example Description
Bandwidth Integer 1024

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

ConnectionStatus String Connected

The status of the endpoint connection. Valid values:

  • Pending: The endpoint connection is being modified.
  • Connecting: The endpoint is waiting for the endpoint service to accept the connection request.
  • Connected: The endpoint is connected to the endpoint service.
  • Disconnecting: The endpoint is disconnecting from the endpoint service.
  • Disconnected: The endpoint is disconnected from the endpoint service.
  • Deleting: The endpoint connection is being deleted.
CreateTime String 2020-01-02T19:11:12Z

The time when the endpoint was created.

EndpointBusinessStatus String Normal

The business status of the endpoint. Valid values:

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

The description of the endpoint.

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

The domain name of the endpoint.

EndpointId String ep-hp33b2e43fays7s8****

The ID of the endpoint.

EndpointName String test

The name of the endpoint.

EndpointStatus String Active

The status of the endpoint. Valid values:

  • Creating: The endpoint is being created.
  • Active: The endpoint is available.
  • Pending: The endpoint is being modified.
  • Deleting: The endpoint is being deleted.
Payer String Endpoint

The payer of the endpoint service. Valid values:

  • Endpoint: the service user.
  • EndpointService: the service provider.
RegionId String eu-west-1

The region ID of the endpoint.

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

The ID of the request.

ResourceOwner Boolean true

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

  • true: yes
  • false: no
ServiceId String epsrv-hp3vpx8yqxblby3i****

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

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

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

VpcId String vpc-fdfhkjafhjvcvdjf****

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

ZoneAffinityEnabled Boolean true

Indicates whether to resolve domain names to the IP address of the nearest zone.

  • true: resolves domain names to the IP address of the nearest zone.
  • false: does not resolve domain names to the IP address of the nearest zone.

Examples

Sample requests

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

Sample success responses

XML format

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

JSON format

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