DescribeZones-阿里云帮助中心

Call the DescribeZones operation to query the list of zones in a specified region that support PrivateLink. In cross-region scenarios, zone support is independent on the endpoint side and the endpoint service side. This operation lets you query the supported zones separately for each side.

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 region ID where the zones are located. Get the region ID by calling the DescribeRegions operation.	cn-hangzhou
ServiceResourceType	string	No	Zone support for PrivateLink in a region depends on the backend service resource type. When querying the list of zones that support PrivateLink, specify the service resource type. Valid values: slb (default): Classic Load Balancer (CLB) alb: Application Load Balancer (ALB) nlb: Network Load Balancer (NLB) gwlb: Gateway Load Balancer (GWLB) Valid values: nlb : nlb alb : alb slb : slb	slb
RegionId	string	Yes	The region ID where the zones are located. Get the region ID by calling the DescribeRegions operation.	cn-hangzhou
CrossRegion	boolean	No	Whether the scenario is cross-region. Default value: false. Set CrossRegion to true and use it 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 your current region that support creating 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 your current region that support cross-region sharing, set CrossRegion to true and CrossRegionSide to EndpointService.	false
CrossRegionSide	string	No	Specify whether to query zone support for the initiator or the service provider in a cross-region connection. Valid values: Endpoint (default): endpoint EndpointService: endpoint service Note This field takes effect only when CrossRegion=true. Valid values: Endpoint : Endpoint EndpointService : EndpointService	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	The zone name.	华东1 可用区B
ZoneId	string	The zone 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.