All Products
Search
Document Center

PrivateLink:ListVpcEndpointConnections

Last Updated:Feb 27, 2024

Queries endpoint connections.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
privatelink:ListVpcEndpointConnectionsRead
  • VpcEndpointService
    acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the endpoint connection.

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

cn-huhehaote
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. Valid values:

  • If this is your first request and no next requests are to be performed, you do not need to specify this parameter.
  • If a next request is to be performed, set the value to the value of NextToken that is returned from the last call.
caeba0bbb2be03f84eb48b699f0a4883
MaxResultsintegerNo

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

50
ServiceIdstringYes

The endpoint service ID.

epsrv-hp3vpx8yqxblby3i****
EniIdstringNo

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

eni-hp32lk0pyv6o94hs****
EndpointIdstringNo

The endpoint ID.

ep-hp33b2e43fays7s8****
ConnectionStatusstringNo

The state of the endpoint connection. Valid values:

  • Pending: The endpoint connection is being modified.
  • Connecting: The endpoint connection is being established.
  • Connected: The endpoint connection is established.
  • Disconnecting: The endpoint is being disconnected from the endpoint service.
  • Disconnected: The endpoint is disconnected from the endpoint service.
  • Deleting: The connection is being deleted.
  • ServiceDeleted: The corresponding endpoint service has been deleted.
Disconnected
EndpointOwnerIdlongNo

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

25346073170691****
ResourceIdstringNo

The service resource ID.

lb-hp32z1wp5peaoox2q****
ReplacedResourceIdstringNo

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

lb-hp32z1wp5peaoox2q****
ResourceGroupIdstringNo

The ID of the resource group to which the endpoint belongs.

rg-acfmy*****

Response parameters

ParameterTypeDescriptionExample
object
Connectionsobject []

The endpoint connections.

Zonesobject []

The zones.

VSwitchIdstring

The ID of the vSwitch to which the endpoint belongs.

vsw-hp3uf6045ljdhd5zr****
ZoneIdstring

The zone ID.

cn-huhehaote-b
ResourceIdstring

The service resource ID.

lb-hp32z1wp5peaoox2q****
EniIdstring

The endpoint ENI ID.

eni-hp32lk0pyv6o94hs****
ZoneDomainstring

The domain name of the zone.

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

The state of the zone. Valid values:

  • Creating: The zone is being created.
  • Wait: The zone is to be connected.
  • Connected: The zone is connected.
  • Deleting: The zone is being deleted.
  • Disconnecting: The zone is being disconnected.
  • Disconnected: The zone is disconnected.
  • Connecting: The zone is being connected.
  • Migrating: The zone is being migrated.
  • Migrated: The zone is migrated.
Connected
ReplacedResourceIdstring

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

lb-hp32z1wp5peaoox2q****
ReplacedEniIdstring

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

eni-hp32lk0pyv6o94hs****
ModifiedTimestring

The time when the endpoint connection was modified.

2021-09-28T10:34:46Z
Bandwidthinteger

The bandwidth of the endpoint connection. Valid values: 1024 to 10240. Unit: Mbit/s.

1024
EndpointOwnerIdlong

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

25346073170691****
ResourceOwnerboolean

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

  • true
  • false
true
ServiceIdstring

The endpoint service ID.

epsrv-hp3vpx8yqxblby3i****
ConnectionStatusstring

The state of the endpoint connection. Valid values:

  • Pending: The connection is being modified.
  • Connecting: The connection is being established.
  • Connected: The connection is established.
  • Disconnecting: The endpoint is being disconnected from the endpoint service.
  • Disconnected: The endpoint is disconnected from the endpoint service.
  • Deleting: The connection is being deleted.
  • ServiceDeleted: The corresponding endpoint service has been deleted.
Disconnected
EndpointIdstring

The endpoint ID.

ep-hp33b2e43fays7s8****
EndpointVpcIdstring

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

vpc-hp356stwkxg3fn2xe****
ResourceGroupIdstring

The ID of the resource group to which the endpoint belongs.

rg-acfmw353z35v***
NextTokenstring

The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Valid values:

  • If no value is returned for NextToken, no next requests are performed.
  • If a value is returned for NextToken, the value can be used in the next request to retrieve a new page of results.
caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

The request ID.

0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResultsinteger

The number of entries returned on each page.

50
TotalCountstring

The total number of entries returned.

1

Examples

Sample success responses

JSONformat

{
  "Connections": [
    {
      "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,
      "EndpointOwnerId": 0,
      "ResourceOwner": true,
      "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
      "ConnectionStatus": "Disconnected",
      "EndpointId": "ep-hp33b2e43fays7s8****",
      "EndpointVpcId": "vpc-hp356stwkxg3fn2xe****",
      "ResourceGroupId": "rg-acfmw353z35v***"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": "1"
}

Error codes

HTTP status codeError codeError messageDescription
400EndpointServiceNotFoundThe specified Service does not exist.The specified Service does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-27The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: ConnectionId
Output ParametersThe response structure of the API has changed.
2023-09-19The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2023-03-02The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2022-09-20The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId
Output ParametersThe response structure of the API has changed.
2022-01-06API Description Update. The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.