DescribeAvailabilityZones - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries a list of the zones that are supported by an ApsaraDB for MongoDB instance.

Operation description

Queries the zones in which an ApsaraDB for MongoDB instance can be deployed under specified purchase conditions. The region ID is required in the purchase condition.

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
dds:DescribeAvailabilityZones	list	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. You can call the DescribeRegions operation to query the latest available regions.	cn-hangzhou
ZoneId	string	No	The zone ID of the instance. You can call the DescribeRegions operation to query available zones.	cn-hangzhou-b
InstanceChargeType	string	No	The billing method. Valid values: PrePaid (default): subscription PostPaid: pay-as-you-go	PrePaid
DbType	string	No	The architecture of the instance. Valid values: normal: replica set instance sharding: sharded cluster instance	normal
ResourceGroupId	string	No	The ID of the resource group. For more information, see View basic information of a resource group.	rg-acfmx2m4rqu7pry
AcceptLanguage	string	No	The language of the values of the returned RegionName and ZoneName parameters. Valid values: zh (default): Chinese en: English	en
StorageSupport	string	No	The storage type of the instance. cloud: The system displays only zones in which cloud disk-based instances can be deployed. local: The system displays only zones in which local disk-based instances can be deployed. default or null: The system displays only zones in which cloud disk-based and local disk-based instances can be deployed.	local
MongoType	string	No	The edition of the instance. High-Available Edition and Preview Edition (dbfs) are supported.	dbfs
StorageType	string	No	The storage type of the instance. Valid values: cloud_essd1: PL1 enhanced SSD (ESSD) cloud_essd2: PL2 ESSD cloud_essd3: PL3 ESSD local_ssd: Local SSD Note Instances that run MongoDB 4.4 or later support only cloud disks. cloud_essd1 is selected if you leave this parameter empty. Instances that run MongoDB 4.2 and earlier support only local disks. local_ssd is selected if you leave this parameter empty.	local_ssd
ExcludeZoneId	string	No	The zone ID that is excluded from the query results.	cn-shanghai-g
ExcludeSecondaryZoneId	string	No	The secondary zone ID that is excluded from the query results. You can configure the ExcludeZoneId and ExcludeSecondaryZoneId parameters to specify the IDs of multiple zones that are excluded from the query results.	cn-shanghai-b
DBInstanceClass	string	No	The instance type of the instance.	dds.mongo.standard
EngineVersion	string	No	The database engine version of the instance.	5.0
ReplicationFactor	string	No	The number of nodes. This parameter is available only for replica set instances. Enumeration Value: 1: 1. 3: 3. 5: 5. 7: 7.	3

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	19A13A33-0FAD-5120-8AE1-B1636F74DD80
AvailableZones	array<object>	The details of the zones in which you can create ApsaraDB for MongoDB instances.
	object
ZoneId	string	The ID of the zone.	cn-beijing-f
ZoneName	string	The name of the zone. The return value of the ZoneName parameter is in the language that is specified by the AcceptLanguage parameter. For example, if the value of the ZoneId parameter in the response is cn-hangzhou-h, the following values are returned for the ZoneName parameter: If the value of the AcceptLanguage parameter is zh, H is returned for the ZoneName parameter. If the value of the AcceptLanguage parameter is en, Hangzhou Zone H is returned for the ZoneName parameter.	Hangzhou Zone H
RegionId	string	The ID of the region. You can call the DescribeRegions operation to query the latest available regions.	cn-beijing

Examples

Sample success responses

JSONformat

{
  "RequestId": "19A13A33-0FAD-5120-8AE1-B1636F74DD80",
  "AvailableZones": [
    {
      "ZoneId": "cn-beijing-f",
      "ZoneName": "Hangzhou Zone H\n",
      "RegionId": "cn-beijing"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-12-27	The request parameters of the API has changed	View Change Details
2023-11-03	The request parameters of the API has changed	View Change Details