ListVpcEndpointZones - PrivateLink - Alibaba Cloud Documentation Center

Call the ListVpcEndpointZones operation to query the zones of an endpoint.

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

get

*VpcEndpoint

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region. 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. Valid values: If this is your first query, you do not need to specify this parameter. If a next page exists, 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	Yes	The ID of the endpoint. After you specify the endpoint ID, the system queries the zones of the endpoint.	ep-hp33b2e43fays7s8****
RegionId	string	Yes	The ID of the region. Call the DescribeRegions operation to obtain the region ID.	cn-huhehaote

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token that is used to retrieve the next page of results. Valid values: If this parameter is empty, no next page exists. If a value is returned, use the value to retrieve the next 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	integer	The total number of entries returned.	12
Zones	array<object>	The collection of zone information.
	object	The information about the zone.
VSwitchId	string	The vSwitch in the zone. The system automatically creates an endpoint elastic network interface (ENI) in the vSwitch.	vsw-hjkshjvdkdvd****
EniIp	string	The IP address of the endpoint ENI.	192.168.2.23
ZoneStatus	string	The status of the zone. Valid values: Creating: The zone is being created. Wait: The zone is waiting 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.	Wait
ZoneId	string	The zone ID.	cn-huhehaote-a
EniId	string	The ID of the endpoint ENI.	eni-hp3c8qj1tyct8aqy****
ZoneDomain	string	The domain name of the zone. After an endpoint connection is established, use this domain name to access the service resources of the endpoint service.	ep-hp3f033dp24c5yc9**-cn-huhehaote-a.epsrv-hp3itcpowf37m3d5**.cn-huhehaote.privatelink.aliyuncs.com
RegionId	string	The ID of the region where the endpoint is deployed.	cn-huhehaote
ZoneIpv6Address	string	The IPv6 address of the endpoint ENI.	2408:4005:3b6:**:6955:c3cb:34c:**

Examples

Success response

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12,
  "Zones": [
    {
      "VSwitchId": "vsw-hjkshjvdkdvd****",
      "EniIp": "192.168.2.23",
      "ZoneStatus": "Wait",
      "ZoneId": "cn-huhehaote-a",
      "EniId": "eni-hp3c8qj1tyct8aqy****",
      "ZoneDomain": "ep-hp3f033dp24c5yc9****-cn-huhehaote-a.epsrv-hp3itcpowf37m3d5****.cn-huhehaote.privatelink.aliyuncs.com",
      "RegionId": "cn-huhehaote",
      "ZoneIpv6Address": "2408:4005:3b6:****:6955:c3cb:34c:****\n"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	EndpointNotFound	The specified Endpoint does not exist.	The specified Endpoint does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.