DescribeAvailableResource -

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeAvailableResource	The operation that you want to perform. Set the value to DescribeAvailableResource.
RegionId	String	Yes	cn-hangzhou	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.
ZoneId	String	No	cn-hangzhou-h	The zone ID of the instance. You can call the DescribeRegions operation to query the most recent zone list.
InstanceChargeType	String	No	PrePaid	The billing method of the instance. Default value: PrePaid. Valid values: PrePaid: subscription PostPaid: pay-as-you-go
DbType	String	No	sharding	The architecture of the instance. Valid values: normal: replica set instance sharding: sharded cluster instance
ResourceGroupId	String	No	rg-acfmyiu4ekp****	The ID of the resource group.

Response parameters


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

Examples

Sample requests

http(s)://mongodb.aliyuncs.com/?Action=DescribeAvailableResource
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAvailableResourceResponse>
    <RequestId>344EE51D-8850-4935-B68B-58A8F4DCE3BD</RequestId>
    <SupportedDBTypes>
        <AvailableZones>
            <SupportedEngineVersions>
                <SupportedEngines>
                    <SupportedNodeTypes>
                        <NodeType>3</NodeType>
                        <NetworkTypes>VPC</NetworkTypes>
                        <AvailableResources>
                            <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}))</InstanceClassRemark>
                            <InstanceClass>mdb.shard.2x.xlarge.d</InstanceClass>
                            <DBInstanceStorageRange>
                                <Min>20</Min>
                                <Max>16000</Max>
                                <Step>10</Step>
                            </DBInstanceStorageRange>
                        </AvailableResources>
                    </SupportedNodeTypes>
                    <Engine>WiredTiger</Engine>
                </SupportedEngines>
                <Version>4.0</Version>
            </SupportedEngineVersions>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <RegionId>cn-hangzhou</RegionId>
        </AvailableZones>
        <DbType>sharding</DbType>
    </SupportedDBTypes>
</DescribeAvailableResourceResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "344EE51D-8850-4935-B68B-58A8F4DCE3BD",
  "SupportedDBTypes" : [ {
    "AvailableZones" : [ {
      "SupportedEngineVersions" : [ {
        "SupportedEngines" : [ {
          "SupportedNodeTypes" : [ {
            "NodeType" : "3",
            "NetworkTypes" : "VPC",
            "AvailableResources" : [ {
              "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}))",
              "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.