ListVpcEndpointConnections API Explained - PrivateLink - Alibaba Cloud - PrivateLink

Queries endpoint connections by calling the ListVpcEndpointConnections operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

privatelink:ListVpcEndpointConnections

list

*VpcEndpointService

acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint connections that you want to query. You can call the DescribeRegions operation to query the region ID.	cn-huhehaote
NextToken	string	No	The token that is used for the next query. Valid values: You do not need to specify this parameter for the first query or if no next query is to be sent. If a next query is to be sent, set the value to the value of NextToken that is returned from the last API call.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 1000. Default value: 50.	50
ServiceId	string	No	The endpoint service ID.	epsrv-hp3vpx8yqxblby3i****
EniId	string	No	The endpoint elastic network interface (ENI) ID.	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 is connected to the endpoint service. Disconnecting: The endpoint is being disconnected from the endpoint service. Disconnected: The endpoint is disconnected from the endpoint service. Deleting: The endpoint connection is being deleted. ServiceDeleted: The corresponding endpoint service is deleted.	Disconnected
EndpointOwnerId	integer	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 service resource that is replaced in the smooth migration scenario.	lb-hp32z1wp5peaoox2q****
RegionId	string	Yes	The region ID of the endpoint connections that you want to query. You can call the DescribeRegions operation to query the region ID.	cn-huhehaote
ResourceGroupId	string	No	The ID of the resource group to which the endpoint belongs.	rg-acfmy*****

Response elements

Element	Type	Description	Example
	object
Connections	array<object>	The information about the endpoint connections.
	array<object>	The information about the endpoint connections.
Zones	array<object>	The zone information.
	object	The zone information.
VSwitchId	string	The ID of the vSwitch to which the endpoint belongs.	vsw-hp3uf6045ljdhd5zr****
ZoneId	string	The ID of the zone.	cn-huhehaote-b
ResourceId	string	The ID of the service resource.	lb-hp32z1wp5peaoox2q****
EniId	string	The ID of the endpoint ENI.	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 status of the zone. Valid values: Creating: The zone is being created. Wait: The endpoint is awaiting connection. Connected: The connection is established. Deleting: The zone is being deleted. Disconnecting: The connection is being terminated. Disconnected: The connection is terminated. Connecting: The connection is being established. Migrating: The zone is being migrated. Migrated: The zone has been migrated.	Connected
ReplacedResourceId	string	The ID of the service resource that is replaced during a smooth migration.	lb-hp32z1wp5peaoox2q****
ReplacedEniId	string	The ID of the endpoint ENI that is replaced during a smooth migration.	eni-hp32lk0pyv6o94hs****
ModifiedTime	string	The time when the connection was modified.	2021-09-28T10:34:46Z
Bandwidth	integer	The bandwidth of the endpoint connection. Unit: Mbit/s.	3072
EndpointOwnerId	integer	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 endpoint connection is being modified. Connecting: The endpoint connection is being established. Connected: The endpoint is connected to the endpoint service. Disconnecting: The endpoint is being disconnected from the endpoint service. Disconnected: The endpoint is disconnected from the endpoint service. Deleting: The endpoint connection is being deleted. ServiceDeleted: The corresponding endpoint service is 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***
TrafficControlMode	string	Scalability: automatic scaling. In this mode, the bandwidth configured for the endpoint connection does not take effect. BandwidthLimit: the bandwidth limit of the endpoint connection. The bandwidth limit is the value of Bandwidth.	BandwidthLimit
EndpointRegionId	string	The region ID of the endpoint.	cn-hangzhou
ServiceRegionId	string	The region ID of the endpoint service.	cn-huhehaote
NextToken	string	The token that is used for the next query. Valid values: If NextToken is empty, no next query is to be sent. If a value of NextToken is returned, the value is the token that is used for the next query.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	The number of entries per page.	50
TotalCount	string	The number of entries returned in the endpoint connection list.	1

Examples

Success response

JSON format

{
  "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": 3072,
      "EndpointOwnerId": 0,
      "ResourceOwner": true,
      "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
      "ConnectionStatus": "Disconnected",
      "EndpointId": "ep-hp33b2e43fays7s8****",
      "EndpointVpcId": "vpc-hp356stwkxg3fn2xe****",
      "ResourceGroupId": "rg-acfmw353z35v***",
      "TrafficControlMode": "BandwidthLimit",
      "EndpointRegionId": "cn-hangzhou",
      "ServiceRegionId": "cn-huhehaote"
    }
  ],
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.