All Products
Search

This Product

    ApsaraDB for MongoDB:DescribeAvailabilityZones

    Document Center

    ApsaraDB for MongoDB:DescribeAvailabilityZones

    Last Updated:Jan 26, 2026

    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.

    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

    dds:DescribeAvailabilityZones

    list

    *All Resource

    *

    		 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 of the product. Valid values:

    • PrePaid: 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 returned RegionName and ZoneName parameter values. Valid values:

    • zh (default): Chinese

    • en: English

    zh
    StorageSupport

    string

    No

    The storage type. Valid values:

    • cloud: displays only zones available for instances that use cloud disks.

    • local: only displays zones available for instances that use local disks instances.

    • default or unspecified: displays zones available for instances that use cloud disks and those that use local disks.

    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. Valid values:

    • cloud_essd1: PL1 Enterprise SSDs (ESSDs)

    • cloud_essd2: PL2 ESSDs

    • cloud_essd3: PL3 ESSDs

    • local_ssd: local SSDs

    Note

    • Instances that run MongoDB 4.4 or later only use cloud disks to store data. If you do not specify this parameter, the value cloud_essd1 is used by default.

    • Instances that run MongoDB 4.2 and earlier only use local disks to store data. If you do not specify this parameter, the value local_ssd is used by default.

    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 in the instance.

    Note

    This parameter is available only for replica set instances.

    Valid values:

    • 1

    • 3

    • 5

    • 7

    Valid values:

    • 1 :

      1

    • 3 :

      3

    • 5 :

      5

    • 7 :

      7

    3
    InstanceType

    string

    No

    The architecture of the instance. Valid values:

    • sharding: sharded cluster instance

    • replicate: replica set or standalone instance

    replicate

    Response elements

    Element

    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.

    杭州 可用区H
    RegionId

    string

    The ID of the region. You can call the DescribeRegions operation to query the latest available regions.

    cn-beijing

    Examples

    Success response

    JSON format

    {
  "RequestId": "19A13A33-0FAD-5120-8AE1-B1636F74DD80",
  "AvailableZones": [
    {
      "ZoneId": "cn-beijing-f",
      "ZoneName": "杭州 可用区H",
      "RegionId": "cn-beijing"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.