ListVpcEndpointZones - PrivateLink - Alibaba Cloud Documentation Center

Queries the zones of an endpoint.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
- The required resource types are displayed in bold characters.
- 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:ListVpcEndpointZones	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 to return on each page. Valid values: 1 to 50. Default value: 50.	50
EndpointId	string	Yes	The ID of the endpoint for which you want to query zones. After you specify an endpoint ID, the system queries the zones of the specified endpoint.	ep-hp33b2e43fays7s8****

Response parameters

Parameter	Type	Description	Example
	object
NextToken	string	The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Valid values: If no value is returned for NextToken, no next requests are performed. If a value is returned for NextToken, the value can be used in the next request to retrieve a new 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.	3
Zones	array<object>	The information about the zones.
Zone	object	The information about the array object.
VSwitchId	string	The ID of 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 state of the zone. Valid values: Creating: The zone is being created. Wait: The zone is 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 the endpoint in the zone is connected to the endpoint service, you can access the service resources of the endpoint service by using the domain name of the zone.	ep-hp3f033dp24c5yc9**-cn-huhehaote.epsrv-hp3itcpowf37m3d5**.cn-huhehaote-a.privatelink.aliyuncs.com
RegionId	string	The region ID of the endpoint.	cn-huhehaote
ZoneIpv6Address	string	Indicates whether the endpoint service supports IPv6. Valid values: true false (default)	false

Examples

Sample success responses

JSONformat

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

Error codes

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

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

Change history

Change time	Summary of changes	Operation
2024-03-20	The Error code has changed. The response structure of the API has changed	View Change Details
2023-08-25	The Error code has changed. The response structure of the API has changed	View Change Details
2022-07-18	The Error code has changed. The response structure of the API has changed	View Change Details
2022-06-28	The Error code has changed. The response structure of the API has changed	View Change Details
2021-03-17	The Error code has changed. The response structure of the API has changed	View Change Details