ListVpcEndpointConnections - PrivateLink - Alibaba Cloud Documentation Center

Queries endpoint connections.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
privatelink:ListVpcEndpointConnections	list	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint connection. You can call the DescribeRegions operation to query the most recent region list.	cn-huhehaote
NextToken	string	No	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
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 50. Default value: 50.	50
ServiceId	string	Yes	The endpoint service ID.	epsrv-hp3vpx8yqxblby3i****
EniId	string	No	The ID of the endpoint elastic network interface (ENI).	eni-hp32lk0pyv6o94hs****
EndpointId	string	No	The endpoint ID.	ep-hp33b2e43fays7s8****
ConnectionStatus	string	No	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
EndpointOwnerId	long	No	The ID of the Alibaba Cloud account to which the endpoint belongs.	25346073170691****
ResourceId	string	No	The service resource ID.	lb-hp32z1wp5peaoox2q****
ReplacedResourceId	string	No	The ID of the replaced service resource in smooth migration scenarios.	lb-hp32z1wp5peaoox2q****
ResourceGroupId	string	No	The ID of the resource group to which the endpoint belongs.	rg-acfmy*****

Response parameters

Parameter	Type	Description	Example
	object
Connections	array<object>	The endpoint connections.
Connection	object	The information about the array object.
Zones	array<object>	The zones.
Zone	object	The information about the array object.
VSwitchId	string	The ID of the vSwitch to which the endpoint belongs.	vsw-hp3uf6045ljdhd5zr****
ZoneId	string	The zone ID.	cn-huhehaote-b
ResourceId	string	The service resource ID.	lb-hp32z1wp5peaoox2q****
EniId	string	The endpoint ENI ID.	eni-hp32lk0pyv6o94hs****
ZoneDomain	string	The domain name of the zone.	ep-hp34jaz8ykl0exwt**-cn-huhehaote.epsrv-hp3vpx8yqxblby3i**.cn-huhehaote-b.privatelink.aliyuncs.com
ZoneStatus	string	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
ReplacedResourceId	string	The ID of the replaced service resource in smooth migration scenarios.	lb-hp32z1wp5peaoox2q****
ReplacedEniId	string	The ID of the replaced endpoint ENI in smooth migration scenarios.	eni-hp32lk0pyv6o94hs****
ModifiedTime	string	The time when the endpoint connection was modified.	2021-09-28T10:34:46Z
Bandwidth	integer	The bandwidth of the endpoint connection. Valid values: 1024 to 10240. Unit: Mbit/s.	1024
EndpointOwnerId	long	The ID of the Alibaba Cloud account to which the endpoint belongs.	25346073170691****
ResourceOwner	boolean	Indicates whether the endpoint and the endpoint service belong to the same Alibaba Cloud account. Valid values: true false	true
ServiceId	string	The endpoint service ID.	epsrv-hp3vpx8yqxblby3i****
ConnectionStatus	string	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
EndpointId	string	The endpoint ID.	ep-hp33b2e43fays7s8****
EndpointVpcId	string	The ID of the virtual private cloud (VPC) to which the endpoint belongs.	vpc-hp356stwkxg3fn2xe****
ResourceGroupId	string	The ID of the resource group to which the endpoint belongs.	rg-acfmw353z35v***
NextToken	string	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
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	The number of entries returned on each page.	50
TotalCount	string	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 code	Error code	Error message	Description
400	EndpointServiceNotFound	The 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 time	Summary of changes	Operation
2023-09-27	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-09-19	The Error code has changed	View Change Details
2023-03-02	The Error code has changed. The response structure of the API has changed	View Change Details
2022-09-20	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2022-01-06	API Description Update. The Error code has changed. The response structure of the API has changed	View Change Details