Use ListVpcEndpoints to retrieve VPC endpoints - PrivateLink - Alibaba Cloud - PrivateLink

The ListVpcEndpoints operation lists endpoints.

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:ListVpcEndpoints

get

*VpcEndpoint

acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the endpoint is deployed. You can call the DescribeRegions operation to obtain the region ID.	cn-huhehaote
NextToken	string	No	The token that is used to retrieve the next page of results. If this is your first query or no next page is available, you do not need to specify this parameter. If a next page is available, set the value to the NextToken value that is returned from the previous call.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	The number of entries to return on each 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: an interface endpoint Reverse: a reverse endpoint GatewayLoadBalancer: a Gateway Load Balancer-type endpoint	Interface
EndpointStatus	string	No	The status 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 connection state of the endpoint. Valid values: Pending: The endpoint connection is being modified. Connecting: The endpoint is connecting. Connected: The endpoint is connected. Disconnecting: The endpoint is disconnecting. Disconnected: The endpoint is disconnected. Deleting: The endpoint is being deleted. ServiceDeleted: The endpoint service with which the endpoint is associated has been deleted.	Disconnected
Tag	array<object>	No	The tags.
	object	No	A tag that consists of a key-value pair.
Key	string	No	The tag key. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	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 and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceJoshua
RegionId	string	Yes	The ID of the region where the endpoint is deployed. You can call the DescribeRegions operation to obtain the region ID.	cn-huhehaote
ResourceGroupId	string	No	The ID of the resource group.	1
AddressIpVersion	string	No	The IP version. Valid values: IPv4: IPv4 DualStack: dual stack	IPv4
ServiceRegionId	string	No	The ID of the region where the endpoint service is deployed.	cn-huhehaote

Response elements

Element	Type	Description	Example
	object
Endpoints	array<object>	A list of endpoints.
	array<object>
VpcId	string	The ID of the 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: an interface endpoint. Reverse: a reverse endpoint. GatewayLoadBalancer: a gateway load balancer endpoint.	Interface
CreateTime	string	The time when the endpoint was created.	2021-09-24T18:00:07Z
ServiceId	string	The ID of the associated endpoint service.	epsrv-hp3vpx8yqxblby3i****
ZoneAffinityEnabled	boolean	Indicates whether zone-aware DNS resolution is enabled. 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 status 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 ID of the region that contains 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	integer	The connection bandwidth of the endpoint, in Mbps.	1024
ConnectionStatus	string	The connection status of the endpoint. Valid values: Pending: The connection is being modified. Connecting: The endpoint is being connected. Connected: The endpoint is connected. Disconnecting: The endpoint is being disconnected. Disconnected: The endpoint is disconnected. Deleting: The endpoint is being deleted. ServiceDeleted: The associated endpoint service has been 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 business status of the endpoint. Valid values: Normal: The endpoint is running as expected. FinancialLocked: The endpoint is locked due to an overdue payment.	Normal
ServiceName	string	The name of the associated endpoint service.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Tags	array<object>	A list of tags.
	object
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua
ResourceGroupId	string	The ID of the resource group.	1
PolicyDocument	string	The RAM access policy. For details on the policy syntax, see Basic elements of a RAM policy.	{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"\",\n \"Principal\": \"\",\n \"Resource\": \"*\"\n }\n ]\n}
AddressIpVersion	string	The IP address family. Valid values: IPv4: IPv4. DualStack: dual stack.	IPv4
ServiceRegionId	string	The ID of the region where the associated endpoint service is deployed.	cn-huhehaote
CrossRegionBandwidth	integer	The bandwidth of the cross-region connection, in Mbps.	1000
NextToken	string	The token to retrieve the next page of results. If NextToken is empty, no next page exists. If a value is returned, use it in your next request to retrieve the next page of results.	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	The number of entries returned per page.	50
TotalCount	integer	The total number of entries that match the query.	12

Examples

Success response

JSON format

{
  "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",
      "ServiceRegionId": "cn-huhehaote",
      "CrossRegionBandwidth": 1000
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.