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

The region ID of the endpoint connection.

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.

ServiceId String Yes epsrv-hp3vpx8yqxblby3i****

The ID of the endpoint service.

EniId String No eni-hp32lk0pyv6o94hs****

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

EndpointId String No ep-hp33b2e43fays7s8****

The ID of the endpoint.

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 endpoint service is deleted.
EndpointOwnerId Long No 25346073170691****

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

ResourceId String No lb-hp32z1wp5peaoox2q****

The ID of the service resource.

ReplacedResourceId String No lb-hp32z1wp5peaoox2q****

The ID of the replaced service resource in smooth migration scenarios.

Response parameters

Parameter Type Example Description
Connections Array of Connection

The information about the endpoint connections.

ResourceOwner Boolean true

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

  • true: yes
  • false: no
Zones Array of Zone

The information about the zones.

VSwitchId String vsw-hp3uf6045ljdhd5zr****

The vSwitch to which the endpoint belongs.

ZoneId String cn-huhehaote-b

The ID of the zone.

ResourceId String lb-hp32z1wp5peaoox2q****

The ID of the service resource.

EniId String eni-hp32lk0pyv6o94hs****

The ID of the endpoint ENI.

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

The domain name of the zone.

ZoneStatus String Connected

The status of the zone. Valid values:

  • Creating: being created
  • Wait: to be connected
  • Connected: connected
  • Deleting: being deleted
  • Disconnecting: disconnecting
  • Disconnected: disconnected
  • Connecting: connecting
  • Migrating: being migrated
  • Migrated: migrated
ReplacedResourceId String lb-hp32z1wp5peaoox2q****

The ID of the replaced service resource in smooth migration scenarios.

ReplacedEniId String eni-hp32lk0pyv6o94hs****

The ID of the replaced endpoint ENI in smooth migration scenarios.

ModifiedTime String 2021-09-28T10:34:46Z

The time when the connection was modified.

Bandwidth Integer 1024

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

EndpointOwnerId Long 25346073170691****

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

ServiceId String epsrv-hp3vpx8yqxblby3i****

The ID of the endpoint service.

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 endpoint service is deleted.
EndpointId String ep-hp33b2e43fays7s8****

The ID of the endpoint.

EndpointVpcId String vpc-hp356stwkxg3fn2xe****

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

NextToken String caeba0bbb2be03f84eb48b699f0a4883

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=ListVpcEndpointConnections
&RegionId=cn-huhehaote
&ServiceId=epsrv-hp3vpx8yqxblby3i****
&<Common request parameters>

Sample success responses

XML format

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

<ListVpcEndpointConnectionsResponse>
    <Connections>
        <ResourceOwner>true</ResourceOwner>
        <Zones>
            <VSwitchId>vsw-hp3uf6045ljdhd5zr****</VSwitchId>
            <ZoneId>cn-huhehaote-b</ZoneId>
            <ResourceId>lb-hp32z1wp5peaoox2q****</ResourceId>
            <EniId>eni-hp32lk0pyv6o94hs****</EniId>
            <ZoneDomain>ep-hp34jaz8ykl0exwt****-cn-huhehaote.epsrv-hp3vpx8yqxblby3i****.cn-huhehaote-b.privatelink.aliyuncs.com</ZoneDomain>
            <ZoneStatus>Connected</ZoneStatus>
            <ReplacedResourceId>lb-hp32z1wp5peaoox2q****</ReplacedResourceId>
            <ReplacedEniId>eni-hp32lk0pyv6o94hs****</ReplacedEniId>
        </Zones>
        <ModifiedTime>2021-09-28T10:34:46Z</ModifiedTime>
        <Bandwidth>1024</Bandwidth>
        <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>
        <ConnectionStatus>Disconnected</ConnectionStatus>
        <EndpointId>ep-hp33b2e43fays7s8****</EndpointId>
        <EndpointVpcId>vpc-hp356stwkxg3fn2xe****</EndpointVpcId>
    </Connections>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
    <MaxResults>50</MaxResults>
</ListVpcEndpointConnectionsResponse>

JSON format

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

{
  "Connections" : [ {
    "ResourceOwner" : true,
    "Zones" : [ {
      "VSwitchId" : "vsw-hp3uf6045ljdhd5zr****",
      "ZoneId" : "cn-huhehaote-b",
      "ResourceId" : "lb-hp32z1wp5peaoox2q****",
      "EniId" : "eni-hp32lk0pyv6o94hs****",
      "ZoneDomain" : "ep-hp34jaz8ykl0exwt****-cn-huhehaote.epsrv-hp3vpx8yqxblby3i****.cn-huhehaote-b.privatelink.aliyuncs.com",
      "ZoneStatus" : "Connected",
      "ReplacedResourceId" : "lb-hp32z1wp5peaoox2q****",
      "ReplacedEniId" : "eni-hp32lk0pyv6o94hs****"
    } ],
    "ModifiedTime" : "2021-09-28T10:34:46Z",
    "Bandwidth" : 1024,
    "ServiceId" : "epsrv-hp3vpx8yqxblby3i****",
    "ConnectionStatus" : "Disconnected",
    "EndpointId" : "ep-hp33b2e43fays7s8****",
    "EndpointVpcId" : "vpc-hp356stwkxg3fn2xe****"
  } ],
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId" : "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "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.