首页 云数据库 MongoDB 版 开发参考 API参考指南 API目录 资源管理 DescribeAvailableResource - 查询指定可用区的资源信息

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

更新时间: 2024-01-16 16:45:07

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

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。您可以通过调用 DescribeRegions 接口进行查询。

cn-hangzhou
ZoneIdstring

可用区 ID。您可以通过 DescribeRegions 接口查看可用的可用区。

cn-hangzhou-h
InstanceChargeTypestring

付费类型,取值说明:

  • PrePaid(默认值):包年包月。
  • PostPaid:按量付费。
PrePaid
DbTypestring

实例的数据库类型,取值说明:

  • normal:副本集实例。
  • sharding:分片集群实例。
sharding
ResourceGroupIdstring

资源组 ID。

rg-acfmyiu4ekp****
StorageTypestring

存储类型,取值说明:

  • local_ssd:SSD 本地盘。

  • cloud_essd1:ESSD PL1 云盘。

  • cloud_essd2:ESSD PL2 云盘。

  • cloud_essd3:ESSD PL3 云盘。

  • cloud_auto:AutoPL 云盘。

默认为空,表示查询所有存储类型。

local_ssd
DBInstanceClassstring

实例规格。

dds.mongo.standard
EngineVersionstring

数据库版本号。

5.0
ReplicationFactorstring

节点数,只适用于副本集。

枚举值:
  • 11
  • 33
  • 55
  • 77
3

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

支持的数据库类型。

AvailableZonesobject []

可用区。

SupportedEngineVersionsobject []

支持的存储引擎版本。

SupportedEnginesobject []

支持的存储引擎。

SupportedNodeTypesobject []

支持的实例类型。

NodeTypestring

实例的节点数。

3
NetworkTypesstring

实例的网络类型。

VPC
AvailableResourcesobject []

可用的资源详情。

InstanceClassRemarkstring

实例规格。

4核8GB(独享型)(当前选择规格:mdb.shard.2x.xlarge.d(4核8G(独享型云盘版),最大连接数:3000,最大IOPS:min{1800+50*存储空间, 21000}))
InstanceClassstring

实例规格族。

mdb.shard.2x.xlarge.d
DBInstanceStorageRangeobject

实例的存储空间范围。

Mininteger

存储空间的最小值,单位:GB。

20
Maxinteger

存储空间的最大值,单位:GB。

16000
Stepinteger

调整存储空间的最小粒度,单位:GB。

10
Enginestring

实例的存储引擎。

WiredTiger
Versionstring

实例的数据库版本。

4.0
ZoneIdstring

可用区 ID。

cn-hangzhou-h
RegionIdstring

地域 ID。

cn-hangzhou
DbTypestring

实例的数据库类型,取值说明:

  • 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-27OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ReplicationFactor
2023-11-03OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:DBInstanceClass
    新增入参:EngineVersion
2023-09-01OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:StorageType
2022-06-14OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
阿里云首页 云数据库 MongoDB 版 相关技术圈