All Products
Search
Document Center

ApsaraDB for MongoDB:DescribeAvailableResource

Last Updated:Mar 15, 2024

Queries the available resources in the specified zone.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
dds:DescribeAvailableResourceREAD
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
ZoneIdstringNo

The ID of the zone. You can call the DescribeRegions operation to query the available zones.

cn-hangzhou-h
InstanceChargeTypestringNo

The billing method of the instance. Valid values:

  • PrePaid (default): subscription
  • PostPaid: pay-as-you-go
PrePaid
DbTypestringNo

The architecture of the instance. Valid values:

  • normal: replica set instance
  • sharding: sharded cluster instance
sharding
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmyiu4ekp****
StorageTypestringNo

The storage type of the instance. Valid values:

  • local_ssd: local SSD
  • cloud_essd1: PL1 enhanced SSD (ESSD)
  • cloud_essd2: PL2 ESSD
  • cloud_essd3: PL3 ESSD
  • cloud_auto: ESSD AutoPL disk

This parameter is empty by default, which indicates all types of storage resources are queried.

local_ssd
DBInstanceClassstringNo

The instance type of the instance.

dds.mongo.standard
EngineVersionstringNo

The major engine version of the instance.

5.0
ReplicationFactorstringNo

The number of nodes, only applicable to replica sets.

Enumeration Value:
  • 1: 1.
  • 3: 3.
  • 5: 5.
  • 7: 7.
3

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

344EE51D-8850-4935-B68B-58A8F4DCE3BD
SupportedDBTypesobject []

The supported database types.

AvailableZonesobject []

The available zones.

SupportedEngineVersionsobject []

The supported storage engine versions.

SupportedEnginesobject []

The supported storage engines.

SupportedNodeTypesobject []

The supported instance types.

NodeTypestring

The number of nodes in the instance.

3
NetworkTypesstring

The network type of the instance.

VPC
AvailableResourcesobject []

The details of the available resources.

InstanceClassRemarkstring

The type of the instance.

4 cores, 8 GB (Dedicated) (Current instance type: mdb.shard.2x.xlarge.d (4 cores, 8 GB (Dedicated cloud-disk), maximum connections: 3000, maximum IOPS: min{1800 + 50 × Storage capacity, 21000}))
InstanceClassstring

The instance family.

mdb.shard.2x.xlarge.d
DBInstanceStorageRangeobject

The storage capacity range of the instance.

Mininteger

The minimum storage capacity. Unit: GB.

20
Maxinteger

The maximum storage capacity. Unit: GB.

16000
Stepinteger

The step size for adjusting the storage capacity. Unit: GB.

10
Enginestring

The storage engine of the instance.

WiredTiger
Versionstring

The database engine version of the instance.

4.0
ZoneIdstring

The ID of the zone.

cn-hangzhou-h
RegionIdstring

The ID of the region.

cn-hangzhou
DbTypestring

The architecture of the instance. Valid values:

  • normal: replica set instance
  • sharding: sharded cluster instance
sharding

Examples

Sample success responses

JSONformat

{
  "RequestId": "344EE51D-8850-4935-B68B-58A8F4DCE3BD",
  "SupportedDBTypes": {
    "SupportedDBType": [
      {
        "AvailableZones": {
          "AvailableZone": [
            {
              "SupportedEngineVersions": {
                "SupportedEngineVersion": [
                  {
                    "SupportedEngines": {
                      "SupportedEngine": [
                        {
                          "SupportedNodeTypes": {
                            "SupportedNodeType": [
                              {
                                "NodeType": "3",
                                "NetworkTypes": "VPC",
                                "AvailableResources": {
                                  "AvailableResource": [
                                    {
                                      "InstanceClassRemark": "4 cores, 8 GB (Dedicated) (Current instance type: mdb.shard.2x.xlarge.d (4 cores, 8 GB (Dedicated cloud-disk), maximum connections: 3000, maximum IOPS: min{1800 + 50 × Storage capacity, 21000}))\n",
                                      "InstanceClass": "mdb.shard.2x.xlarge.d",
                                      "DBInstanceStorageRange": {
                                        "Min": 20,
                                        "Max": 16000,
                                        "Step": 10
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          },
                          "Engine": "WiredTiger"
                        }
                      ]
                    },
                    "Version": "4.0"
                  }
                ]
              },
              "ZoneId": "cn-hangzhou-h",
              "RegionId": "cn-hangzhou"
            }
          ]
        },
        "DbType": "sharding"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-12-27The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ReplicationFactor
2023-11-03The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: DBInstanceClass
    Added Input Parameters: EngineVersion
2023-09-01The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: StorageType
2022-06-14The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.