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

Queries a list of 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 region ID of the endpoints that you want to query. You can call the DescribeRegions operation to obtain the region ID.	cn-huhehaote
NextToken	string	No	Specifies whether to have a token for the next query. Valid values: If this is the first query or there is no next query, you do not need to specify this parameter. If a next query exists, set the value to the NextToken value returned by the previous API 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 that you want to query.	ep-hp33b2e43fays7s8****
ServiceName	string	No	The service name of the endpoint service associated with the endpoint that you want to query.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
VpcId	string	No	The ID of the virtual private cloud (VPC) to which the endpoint belongs.	vpc-fdjkf789dfdfdfde****
EndpointName	string	No	The name of the endpoint.	test
EndpointType	string	No	The endpoint type. Valid values: Interface: interface endpoint. Reverse: reverse endpoint. GatewayLoadBalancer: Gateway Load Balancer endpoint (GWLBe). You can create a Gateway Load Balancer endpoint (GWLBe) to connect to a Gateway Load Balancer (GWLB) for load balancing.	Interface
EndpointStatus	string	No	The status of the endpoint. Valid values: Creating: being created. Active: available. Pending: being modified. Deleting: being deleted.	Active
ConnectionStatus	string	No	The endpoint connection status. Valid values: Pending: being modified. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Disconnected: disconnected. Deleting: being deleted. ServiceDeleted: the corresponding endpoint service has been deleted.	Disconnected
Tag	array<object>	No	The list of tags.
	object	No	The tag.
Key	string	No	The tag key of the instance. 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 of the instance. 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
ResourceGroupId	string	No	The resource group ID.	1
AddressIpVersion	string	No	The protocol version. Valid values: IPv4: IPv4. DualStack: dual-stack.	IPv4
ServiceRegionId	string	No	The region ID of the endpoint service.	cn-huhehaote

Response elements

Element	Type	Description	Example
	object
Endpoints	array<object>	The endpoint information.
	array<object>	The endpoint information.
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 endpoint type. Valid values: Interface: interface endpoint. Reverse: reverse endpoint. GatewayLoadBalancer: Gateway Load Balancer endpoint (GWLBe). You can create a Gateway Load Balancer endpoint (GWLBe) to connect to a Gateway Load Balancer (GWLB) for load balancing.	Interface
CreateTime	string	The time when the endpoint was created.	2021-09-24T18:00:07Z
ServiceId	string	The ID of the endpoint service associated with the endpoint.	epsrv-hp3vpx8yqxblby3i****
ZoneAffinityEnabled	boolean	Indicates whether zone affinity is enabled for the endpoint domain name to resolve to the connected service. Valid values: true: enabled. false: disabled.	true
EndpointDomain	string	The endpoint domain name.	ep-hp33b2e43fays7s8**.epsrv-hp3xdsq46ael67lo**.cn-huhehaote.privatelink.aliyuncs.com
EndpointStatus	string	The status of the endpoint. Valid values: Creating: being created. Active: available. Pending: being modified. Deleting: 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 account. Valid values: true: same account. false: different accounts.	true
Bandwidth	integer	The connection bandwidth of the endpoint. Unit: Mbit/s.	1024
ConnectionStatus	string	The endpoint connection status. Valid values: Pending: being modified. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Disconnected: disconnected. Deleting: being deleted. ServiceDeleted: the corresponding endpoint service has been deleted.	Disconnected
EndpointDescription	string	The description of the endpoint.	This is my Endpoint.
EndpointId	string	The endpoint ID.	ep-hp33b2e43fays7s8****
EndpointBusinessStatus	string	The business status of the endpoint. Valid values: Normal: Normal. FinancialLocked: locked due to overdue payment.	Normal
ServiceName	string	The name of the endpoint service associated with the endpoint.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Tags	array<object>	The list of tags.
	object	The list of tags.
Key	string	The tag key of the instance.	FinanceDept
Value	string	The tag value of the instance.	FinanceJoshua
ResourceGroupId	string	The instance ID of the resource group.	1
PolicyDocument	string	The RAM access policy. For more information about policy definitions, see Basic elements of a permission policy.	{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"\",\n \"Principal\": \"\",\n \"Resource\": \"*\"\n }\n ]\n}
AddressIpVersion	string	The protocol version. Valid values: IPv4: IPv4. DualStack: dual-stack.	IPv4
ServiceRegionId	string	The region ID of the endpoint service associated with the endpoint.	cn-huhehaote
CrossRegionBandwidth	integer	The cross-region bandwidth of the endpoint. Unit: Mbit/s.	1000
ProtectedEnabled	boolean	Specifies whether managed protection is enabled. This parameter takes effect only for STS-based calls. Valid values: true: enabled. After managed protection is enabled, only the same user who created the endpoint can modify or delete it through STS. false: disabled.
NextToken	string	Indicates whether a next query exists. Valid values: If NextToken is empty, no next query exists. If NextToken is returned, the value indicates the token for the next query.	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	The number of entries per page.	50
TotalCount	integer	The total number of entries returned.	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,
      "ProtectedEnabled": false
    }
  ],
  "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.