DescribeAvailableResource - 查询指定可用区的资源信息 - 云数据库 MongoDB

查询指定可用区的资源信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dds:DescribeAvailableResource	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。您可以通过调用 DescribeRegions 接口进行查询。	cn-hangzhou
ZoneId	string	否	可用区 ID。您可以通过 DescribeRegions 接口查看可用的可用区。	cn-hangzhou-h
InstanceChargeType	string	否	付费类型，取值说明： PrePaid（默认值）：包年包月。 PostPaid：按量付费。	PrePaid
DbType	string	否	实例的数据库类型，取值说明： normal：副本集实例。 sharding：分片集群实例。	sharding
ResourceGroupId	string	否	资源组 ID。	rg-acfmyiu4ekp****
StorageType	string	否	存储类型，取值说明： local_ssd：SSD 本地盘。 cloud_essd1：ESSD PL1 云盘。 cloud_essd2：ESSD PL2 云盘。 cloud_essd3：ESSD PL3 云盘。 cloud_auto：AutoPL 云盘。默认为空，表示查询所有存储类型。	local_ssd
DBInstanceClass	string	否	实例规格。	dds.mongo.standard
EngineVersion	string	否	数据库版本号。	5.0
ReplicationFactor	string	否	节点数，只适用于副本集。枚举值： 1：1。 3：3。 5：5。 7：7。	3

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	344EE51D-8850-4935-B68B-58A8F4DCE3BD
SupportedDBTypes	array<object>	支持的数据库类型。
	object
AvailableZones	array<object>	可用区。
	object
SupportedEngineVersions	array<object>	支持的存储引擎版本。
	object
SupportedEngines	array<object>	支持的存储引擎。
	object
SupportedNodeTypes	array<object>	支持的实例类型。
	object
NodeType	string	实例的节点数。	3
NetworkTypes	string	实例的网络类型。	VPC
AvailableResources	array<object>	可用的资源详情。
	object
InstanceClassRemark	string	实例规格。	4核8GB（独享型）（当前选择规格：mdb.shard.2x.xlarge.d（4核8G（独享型云盘版），最大连接数：3000，最大IOPS：min{1800+50*存储空间, 21000}））
InstanceClass	string	实例规格族。	mdb.shard.2x.xlarge.d
DBInstanceStorageRange	object	实例的存储空间范围。
Min	integer	存储空间的最小值，单位：GB。	20
Max	integer	存储空间的最大值，单位：GB。	16000
Step	integer	调整存储空间的最小粒度，单位：GB。	10
Engine	string	实例的存储引擎。	WiredTiger
Version	string	实例的数据库版本。	4.0
ZoneId	string	可用区 ID。	cn-hangzhou-h
RegionId	string	地域 ID。	cn-hangzhou
DbType	string	实例的数据库类型，取值说明： normal：副本集实例。 sharding：分片集群实例。	sharding

示例

正常返回示例

JSON格式

{
  "RequestId": "344EE51D-8850-4935-B68B-58A8F4DCE3BD",
  "SupportedDBTypes": {
    "SupportedDBType": [
      {
        "AvailableZones": {
          "AvailableZone": [
            {
              "SupportedEngineVersions": {
                "SupportedEngineVersion": [
                  {
                    "SupportedEngines": {
                      "SupportedEngine": [
                        {
                          "SupportedNodeTypes": {
                            "SupportedNodeType": [
                              {
                                "NodeType": "3",
                                "NetworkTypes": "VPC",
                                "AvailableResources": {
                                  "AvailableResource": [
                                    {
                                      "InstanceClassRemark": "4核8GB（独享型）（当前选择规格：mdb.shard.2x.xlarge.d（4核8G（独享型云盘版），最大连接数：3000，最大IOPS：min{1800+50*存储空间, 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"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-12-27	OpenAPI 入参发生变更	查看变更详情
2023-11-03	OpenAPI 入参发生变更	查看变更详情
2023-09-01	OpenAPI 入参发生变更	查看变更详情
2022-06-14	OpenAPI 返回结构发生变更	查看变更详情