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 cn-huhehaote

The region ID of the endpoints.

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

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The token that is used for the next query. Valid values:

  • If this is your first query or no next query is to be sent, ignore this parameter.
  • If a next query is to be sent, set the value to the value of NextToken that is returned from the last call.
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.

EndpointType String No Interface

The type of the endpoint.

Set the value to Interface, which specifies slb for the ServiceId parameter. The value slb specifies the Classic Load Balancer (CLB) endpoint type.

EndpointStatus String No Active

The status of the endpoint. Valid values:

  • Creating: being created
  • Active: available
  • Pending: being modified
  • Deleting: being deleted
ConnectionStatus String No Disconnected

The status of the endpoint connection. Valid values:

  • Pending: being modified
  • Connecting: connecting
  • Connected: connected
  • Disconnecting: disconnecting
  • Disconnected: disconnected
  • Deleting: being deleted
  • ServiceDeleted: The corresponding service is deleted.

Response parameters

Parameter Type Example Description
Endpoints Array of Endpoint

The list of endpoints.

VpcId String vpc-hp356stwkxg3fn2xe****

The VPC to which the endpoint belongs.

EndpointName String test

The name of the endpoint.

EndpointType String Interface

The type of the endpoint.

Set the value to Interface, which indicates that slb is set for the ServiceId parameter. The value slb indicates the CLB endpoint type.

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

The time when the endpoint was created.

ServiceId String epsrv-hp3vpx8yqxblby3i****

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

ZoneAffinityEnabled Boolean true

Indicates whether zone affinity is enabled. Valid values:

  • true: yes
  • false: no
EndpointDomain String ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com

The domain name of the endpoint.

EndpointStatus String Active

The status of the endpoint. Valid values:

  • Creating: being created
  • Active: available
  • Pending: being modified
  • Deleting: being deleted
RegionId String cn-huhehaote

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
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: being modified
  • Connecting: connecting
  • Connected: connected
  • Disconnecting: disconnecting
  • Disconnected: disconnected
  • Deleting: being deleted
  • ServiceDeleted: The corresponding service is deleted.
EndpointDescription String This is my Endpoint.

The description of the endpoint.

EndpointId String ep-hp33b2e43fays7s8****

The ID of the endpoint.

EndpointBusinessStatus String Normal

The business status of the endpoint. Valid values:

  • Normal: normal
  • FinacialLocked: locked due to overdue payments
ServiceName String com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****

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

NextToken String caeba0bbb2be03f84eb48b699f0a****

The token that is used for the next query. Valid values:

  • If the value returned of NextToken is empty, it indicates that no next query is to be sent.
  • If the value returned of NextToken is not empty, the value indicates the token that is used for the next query.
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The ID of the request.

MaxResults String 50

The number of entries returned per page.

Examples

Sample requests

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

Sample success responses

XML format

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

<ListVpcEndpointsResponse>
    <Endpoints>
        <VpcId>vpc-hp356stwkxg3fn2xe****</VpcId>
        <EndpointName>test</EndpointName>
        <EndpointType>Interface</EndpointType>
        <CreateTime>2021-09-24T18:00:07Z</CreateTime>
        <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>
        <ZoneAffinityEnabled>true</ZoneAffinityEnabled>
        <EndpointDomain>ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com</EndpointDomain>
        <EndpointStatus>Active</EndpointStatus>
        <RegionId>cn-huhehaote</RegionId>
        <ResourceOwner>true</ResourceOwner>
        <Bandwidth>1024</Bandwidth>
        <ConnectionStatus>Disconnected</ConnectionStatus>
        <EndpointDescription>This is my Endpoint.</EndpointDescription>
        <EndpointId>ep-hp33b2e43fays7s8****</EndpointId>
        <EndpointBusinessStatus>Normal</EndpointBusinessStatus>
        <ServiceName>com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****</ServiceName>
    </Endpoints>
    <NextToken>caeba0bbb2be03f84eb48b699f0a****</NextToken>
    <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
    <MaxResults>50</MaxResults>
</ListVpcEndpointsResponse>

JSON format

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

{
  "Endpoints" : [ {
    "VpcId" : "vpc-hp356stwkxg3fn2xe****",
    "EndpointName" : "test",
    "EndpointType" : "Interface",
    "CreateTime" : "2021-09-24T18:00:07Z",
    "ServiceId" : "epsrv-hp3vpx8yqxblby3i****",
    "ZoneAffinityEnabled" : true,
    "EndpointDomain" : "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
    "EndpointStatus" : "Active",
    "RegionId" : "cn-huhehaote",
    "ResourceOwner" : true,
    "Bandwidth" : 1024,
    "ConnectionStatus" : "Disconnected",
    "EndpointDescription" : "This is my Endpoint.",
    "EndpointId" : "ep-hp33b2e43fays7s8****",
    "EndpointBusinessStatus" : "Normal",
    "ServiceName" : "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****"
  } ],
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId" : "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults" : "50"
}

Error codes

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