ListVpcEndpoints - PrivateLink - Alibaba Cloud Documentation Center

Queries a list of endpoints.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:ListVpcEndpoints	get	*VpcEndpoint `acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint. 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 parameter to the value of NextToken that is returned from the last call.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 1000. Default value: 50.	50
EndpointId	string	No	The ID of the endpoint.	ep-hp33b2e43fays7s8****
ServiceName	string	No	The name of the endpoint service with which the endpoint is associated.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
VpcId	string	No	The ID of the VPC to which the endpoint belongs.	vpc-fdjkf789dfdfdfde****
EndpointName	string	No	The name of the endpoint.	test
EndpointType	string	No	The type of the endpoint. Valid values: Interface: interface endpoint Reverse: reverse endpoint	Interface
EndpointStatus	string	No	The state of the endpoint. Valid values: Creating: The endpoint is being created. Active: The endpoint is available. Pending: The endpoint is being modified. Deleting: The endpoint is being deleted.	Active
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
Tag	array<object>	No	The tags.
	object	No	The tag.
Key	string	No	The key of the tag added to the resource. You can specify at most 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.	FinanceDept
Value	string	No	The tag value. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua
ResourceGroupId	string	No	The ID of the resource group.	1
AddressIpVersion	string	No	The protocol. Valid values: IPv4 DualStack	IPv4

Response parameters

Parameter	Type	Description	Example
	object
Endpoints	array<object>	The information about the endpoints.
Endpoint	object	The information about the endpoints.
VpcId	string	The ID of the virtual private cloud (VPC) to which the endpoint belongs.	vpc-hp356stwkxg3fn2xe****
EndpointName	string	The name of the endpoint.	test
EndpointType	string	The type of the endpoint. Valid values: Interface: interface endpoint Reverse: reverse endpoint	Interface
CreateTime	string	The time when the endpoint was created.	2021-09-24T18:00:07Z
ServiceId	string	The ID of the endpoint service that is associated with the endpoint.	epsrv-hp3vpx8yqxblby3i****
ZoneAffinityEnabled	boolean	Indicates whether the domain name of the nearest endpoint that is associated with the endpoint service is resolved first. Valid values: true false	true
EndpointDomain	string	The domain name of the endpoint.	ep-hp33b2e43fays7s8**.epsrv-hp3xdsq46ael67lo**.cn-huhehaote.privatelink.aliyuncs.com
EndpointStatus	string	The state of the endpoint. Valid values: Creating: The endpoint is being created. Active: The endpoint is available. Pending: The endpoint is being modified. Deleting: The endpoint is being deleted.	Active
RegionId	string	The region ID of the endpoint.	cn-huhehaote
ResourceOwner	boolean	Indicates whether the endpoint and the endpoint service belong to the same Alibaba Cloud account. Valid values: true false	true
Bandwidth	long	The bandwidth of the endpoint connection. Unit: Mbit/s.	1024
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 connection is established. 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 service is deleted.	Disconnected
EndpointDescription	string	The description of the endpoint.	This is my Endpoint.
EndpointId	string	The ID of the endpoint.	ep-hp33b2e43fays7s8****
EndpointBusinessStatus	string	The service state of the endpoint. Valid values: Normal: The endpoint runs as expected. FinancialLocked: The endpoint is locked due to overdue payments.	Normal
ServiceName	string	The name of the endpoint service that is associated with the endpoint.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Tags	array<object>	The tags added to the resource.
TagModel	object	The tag list.
Key	string	The key of the tag added to the resource.	FinanceDept
Value	string	The value of the tag added to the resource.	FinanceJoshua
ResourceGroupId	string	The ID of the resource group.	1
PolicyDocument	string	The Resource Access Management (RAM) policy. For more information about policy definitions, see Policy elements.	{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"\",\n \"Principal\": \"\",\n \"Resource\": \"*\"\n }\n ]\n}
AddressIpVersion	string	The protocol. Valid values: IPv4 DualStack	IPv4
NextToken	string	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 parameter to the value of NextToken that is returned from the last call.	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	The number of entries returned on each page.	50
TotalCount	integer	The total number of entries returned.	12

Examples

Sample success responses

JSONformat

{
  "Endpoints": [
    {
      "VpcId": "vpc-hp356stwkxg3fn2xe****",
      "EndpointName": "test",
      "EndpointType": "Interface",
      "CreateTime": "2021-09-24T18:00:07Z",
      "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
      "ZoneAffinityEnabled": true,
      "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
      "EndpointStatus": "Active",
      "RegionId": "cn-huhehaote",
      "ResourceOwner": true,
      "Bandwidth": 1024,
      "ConnectionStatus": "Disconnected",
      "EndpointDescription": "This is my Endpoint.",
      "EndpointId": "ep-hp33b2e43fays7s8****",
      "EndpointBusinessStatus": "Normal",
      "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ],
      "ResourceGroupId": "1",
      "PolicyDocument": "{\\n  \\\"Version\\\": \\\"1\\\",\\n  \\\"Statement\\\": [\\n    {\\n      \\\"Effect\\\": \\\"Allow\\\",\\n      \\\"Action\\\": \\\"*\\\",\\n      \\\"Principal\\\": \\\"*\\\",\\n      \\\"Resource\\\": \\\"*\\\"\\n    }\\n  ]\\n}",
      "AddressIpVersion": "IPv4"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-09-12	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2024-05-10	The response structure of the API has changed	View Change Details
2023-09-26	The response structure of the API has changed	View Change Details
2023-09-19	The request parameters of the API has changed	View Change Details
2023-09-05	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-03-02	API Description Update. The response structure of the API has changed	View Change Details
2022-07-26	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2021-03-17	The response structure of the API has changed	View Change Details