Queries endpoints.

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 ListVpcEndpoints

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

RegionId String Yes eu-west-1

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

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The query token. Set this parameter to the NextToken value that is returned in the last API call. If no subsequent queries are to be sent, you can leave the parameter empty.

MaxResults Integer No 50

The number of entries to return on each page. Valid values: 1 to 50. Default value: 50.

EndpointId String No ep-hp33b2e43fays7s8****

The ID of the endpoint that you want to query.

ServiceName String No com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****

The name of the endpoint service that is associated with the endpoint to be queried.

VpcId String No vpc-fdjkf789dfdfdfde****

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

EndpointName String No test

The name of the endpoint.

EndpointStatus String No 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.
ConnectionStatus String No Disconnected

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.
  • ServiceDeleted: The endpoint service with which the endpoint is associated is deleted.

Response parameters

Parameter Type Example Description
Endpoints Array of Endpoint

The list of endpoints.

Bandwidth Long 1024

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

ConnectionStatus String Disconnected

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.
  • ServiceDeleted: The endpoint service with which the endpoint is associated is 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.
RegionId String eu-west-1

The region ID of the endpoint.

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-hp356stwkxg3fn2xe****

The 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.
MaxResults String 50

The number of entries returned on each page.

NextToken String caeba0bbb2be03f84eb48b699f0a****

The token that is required for the next query. If the NextToken parameter is empty, no subsequent query will be sent.

RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListVpcEndpoints
&RegionId=eu-west-1
&<Common request parameters>

Sample success responses

XML format

<ListVpcEndpointsResponse>
  <Endpoints>
        <EndpointDomain>ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com</EndpointDomain>
        <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-hp356stwkxg3fn2xe****</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>Disconnected</ConnectionStatus>
        <ZoneAffinityEnabled>true</ZoneAffinityEnabled>
  </Endpoints>
  <NextToken>caeba0bbb2be03f84eb48b699f0a****</NextToken>
  <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
  <MaxResults>50</MaxResults>
</ListVpcEndpointsResponse>

JSON format

{
    "Endpoints": {
        "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
        "CreateTime": "2020-01-02T19:11:12Z",
        "ResourceOwner": true,
        "EndpointBusinessStatus": "Normal",
        "EndpointDescription": "This is my Endpoint.",
        "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
        "EndpointStatus": "Active",
        "VpcId": "vpc-hp356stwkxg3fn2xe****",
        "EndpointName": "test",
        "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
        "Bandwidth": 1024,
        "EndpointId": "ep-hp33b2e43fays7s8****",
        "RegionId": "eu-west-1",
        "ConnectionStatus": "Disconnected",
        "ZoneAffinityEnabled": true
    },
    "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
    "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
    "MaxResults": 50
}

Error codes

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