Call the DescribeZones API to query available zones - PrivateLink - Alibaba Cloud - PrivateLink

Queries the list of zones supported by PrivateLink in a specified region. In cross-region scenarios, the zones supported on the endpoint side and the endpoint service side are independent of each other. This operation allows you to query the supported zones for the endpoint side and the endpoint service side separately.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the zones reside. You can call the DescribeRegions operation to obtain the region ID.	cn-hangzhou
ServiceResourceType	string	No	The zone availability of PrivateLink in a region depends on the backend EPS resource type. You can specify the EPS resource type when querying the list of zones supported by PrivateLink. Valid values: slb (default): the EPS resource type is Classic Load Balancer (CLB). alb: the EPS resource type is Application Load Balancer (ALB). nlb: the EPS resource type is Network Load Balancer (NLB). gwlb: the EPS resource type is Gateway Load Balancer (GWLB).	slb
RegionId	string	Yes	可用区所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
CrossRegion	boolean	No	Specifies whether this is a cross-region scenario. Default value: false. Set CrossRegion to true and use it together with CrossRegionSide in the following scenarios: As a service consumer: You need to create a cross-region endpoint to connect to an endpoint service in another region. To query the zones in the current region that support cross-region endpoints, set CrossRegion to true and CrossRegionSide to Endpoint. As a service provider: You need to share your endpoint service across regions with service consumers in other regions. To query the zones in the current region that support cross-region sharing, set CrossRegion to true and CrossRegionSide to EndpointService.	false
CrossRegionSide	string	No	Specifies whether to query the active zone support for the initiator side or the service side in a cross-region connection. Valid values: Endpoint (default): endpoint. EndpointService: endpoint service. Note This parameter takes effect only when CrossRegion is set to true.	EndpointService

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F
Zones	object
Zone	array<object>	The collection of zones.
	object	The collection of zones.
LocalName	string	可用区名称。	华东1 可用区B
ZoneId	string	可用区 ID。	cn-hangzhou-b

Examples

Success response

JSON format

{
  "RequestId": "611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F",
  "Zones": {
    "Zone": [
      {
        "LocalName": "华东1 可用区B",
        "ZoneId": "cn-hangzhou-b"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.