DescribeAvailableResource - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

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 keyword: refers to the condition keyword defined by the cloud product itself.
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.

Operate	access level	Resource type	conditional keyword	Association operation
dds:DescribeAvailableResource	READ	MongoDB acs:dds:{#regionId}:{#accountId}:dbinstance/*	without	without

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 most recent region list.	cn-hangzhou
ZoneId	string	No	The zone ID of the instance. You can call the DescribeRegions operation to query the most recent zone list.	cn-hangzhou-h
InstanceChargeType	string	No	The billing method of the instance. Default value: PrePaid. 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	sharding
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmyiu4ekp****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	344EE51D-8850-4935-B68B-58A8F4DCE3BD
SupportedDBTypes	array	The available database types.
	object
AvailableZones	array	The available zones.
	object
SupportedEngineVersions	array	The available storage engine versions.
	object
SupportedEngines	array	The available storage engines.
	object
SupportedNodeTypes	array	The available node types.
	object
NodeType	string	The number of nodes in the instance.	3
NetworkTypes	string	The network type of the instance.	VPC
AvailableResources	array	Details about the available resources.
	object
InstanceClassRemark	string	The instance type.
InstanceClass	string	The instance class.	mdb.shard.2x.xlarge.d
DBInstanceStorageRange	object	The storage capacity range of the instance.
Min	integer	The minimum storage capacity. Unit: GB.	20
Max	integer	The maximum storage capacity. Unit: GB.	16000
Step	integer	The step size for adjusting the storage capacity. Unit: GB.	10
Engine	string	The storage engine of the instance.	WiredTiger
Version	string	The database engine version of the instance.	4.0
ZoneId	string	The zone ID of the instance.	cn-hangzhou-h
RegionId	string	The region ID of the instance.	cn-hangzhou
DbType	string	The architecture of the instance. Valid values: normal: replica set instance sharding: sharded cluster instance	sharding

Example

Normal return example

JSONFormat

{
  "RequestId": "344EE51D-8850-4935-B68B-58A8F4DCE3BD",
  "SupportedDBTypes": {
    "SupportedDBType": [
      {
        "AvailableZones": {
          "AvailableZone": [
            {
              "SupportedEngineVersions": {
                "SupportedEngineVersion": [
                  {
                    "SupportedEngines": {
                      "SupportedEngine": [
                        {
                          "SupportedNodeTypes": {
                            "SupportedNodeType": [
                              {
                                "NodeType": "3",
                                "NetworkTypes": "VPC",
                                "AvailableResources": {
                                  "AvailableResource": [
                                    {
                                      "InstanceClassRemark": "",
                                      "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 API error center.

Change history

Change time

Summary of changes

Operate

2022-06-14

The response structure of the API operation has changed

Change item	Change content
Output Parameters	The response structure of the API operation has changed