Queries endpoint connections.

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 ListVpcEndpointConnections

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

RegionId String Yes eu-west-1

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

ServiceId String Yes epsrv-hp3vpx8yqxblby3i****

The ID of the endpoint service.

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.

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.
EndpointOwnerId Long No 12345678

The ID of the Alibaba Cloud account to which the endpoint belongs.

Response parameters

Parameter Type Example Description
Connections Array of Connection

The information about the endpoint connections.

Bandwidth Integer 1024

The 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.
EndpointId String ep-hp33b2e43fays7s8****

The ID of the endpoint.

EndpointOwnerId Long 12345678

The ID of the Alibaba Cloud account to which the endpoint belongs.

EndpointVpcId String vpc-hp356stwkxg3fn2xe****

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

ModifiedTime String 2020-09-10T01:03:38Z

The time when the connection was modified.

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.

Zones Array of Zone

The information about the zones.

EniId String eni-hp32lk0pyv6o94hs****

The ID of the endpoint elastic network interface (ENI).

ResourceId String lb-hp32z1wp5peaoox2q****

The ID of the service resource.

VSwitchId String vsw-hp3uf6045ljdhd5zr****

The vSwitch to which the endpoint belongs.

ZoneDomain String ep-hp34jaz8ykl0exwt****-cn-huhehaote.epsrv-hp3vpx8yqxblby3i****.cn-huhehaote-b.privatelink.aliyuncs.com

The domain name of the zone.

ZoneId String eu-west-1a

The ID of the zone.

MaxResults String 50

The number of entries returned on each page.

NextToken String caeba0bbb2be03f84eb48b699f0a4883

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=ListVpcEndpointConnections
&RegionId=eu-west-1
&ServiceId=epsrv-hp3vpx8yqxblby3i****
&<Common request parameters>

Sample success responses

XML format

<ListVpcEndpointConnectionsResponse>
  <Connections>
        <EndpointOwnerId>12345678</EndpointOwnerId>
        <ModifiedTime>2020-09-10T01:03:38Z</ModifiedTime>
        <EndpointId>ep-hp33b2e43fays7s8****</EndpointId>
        <Bandwidth>1024</Bandwidth>
        <ResourceOwner>true</ResourceOwner>
        <EndpointVpcId>vpc-hp356stwkxg3fn2xe****</EndpointVpcId>
        <ConnectionStatus>Disconnected</ConnectionStatus>
        <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>
        <Zones>
              <EniId>eni-hp32lk0pyv6o94hs****</EniId>
              <ZoneId>eu-west-1a</ZoneId>
              <ResourceId>lb-hp32z1wp5peaoox2q****</ResourceId>
              <VSwitchId>vsw-hp3uf6045ljdhd5zr****</VSwitchId>
              <ZoneDomain>ep-hp34jaz8ykl0exwt****-cn-huhehaote.epsrv-hp3vpx8yqxblby3i****.cn-huhehaote-b.privatelink.aliyuncs.com</ZoneDomain>
        </Zones>
  </Connections>
  <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
  <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
  <MaxResults>50</MaxResults>
</ListVpcEndpointConnectionsResponse>

JSON format

{
    "Connections": {
        "EndpointOwnerId": 12345678,
        "ModifiedTime": "2020-09-10T01:03:38Z",
        "EndpointId": "ep-hp33b2e43fays7s8****",
        "Bandwidth": 1024,
        "ResourceOwner": true,
        "EndpointVpcId": "vpc-hp356stwkxg3fn2xe****",
        "ConnectionStatus": "Disconnected",
        "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
        "Zones": {
            "EniId": "eni-hp32lk0pyv6o94hs****",
            "ZoneId": "eu-west-1a",
            "ResourceId": "lb-hp32z1wp5peaoox2q****",
            "VSwitchId": "vsw-hp3uf6045ljdhd5zr****",
            "ZoneDomain": "ep-hp34jaz8ykl0exwt****-cn-huhehaote.epsrv-hp3vpx8yqxblby3i****.cn-huhehaote-b.privatelink.aliyuncs.com"
        }
    },
    "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
    "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
    "MaxResults": 50
}

Error codes

HttpCode Error code Error message Description
400 EndpointServiceNotFound The specified Service does not exist. The error message returned because the specified endpoint service does not exist.

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