文档

DescribeDBInstancesOverview - 查询实例的概览信息

更新时间:

查询一个或多个云数据库MongoDB实例的概览信息。

接口说明

  • 如果您未指定实例的具体信息,则返回当前账号的目标地域下所有实例的概览信息。

  • 该接口返回结果不进行分页。

调试

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

调试

授权信息

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

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

请求参数

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

地域 ID,您可以调用 DescribeRegions 查询。

cn-hangzhou
InstanceIdsstring

需要查询概览的实例 ID。

说明
  • 如果不传入该参数,默认查询当前阿里云账号下的所有实例。
  • 支持传入多个实例 ID,实例 ID 之间以英文逗号(,)分隔。
  • dds-bp12c5b040dc****
    InstanceStatusstring

    实例的状态信息,取值详情请参见实例状态表

    Running
    ChargeTypestring

    实例的付费类型,取值:

    • PrePaid:预付费,包年包月。
    • PostPaid:按量付费。
    PostPaid
    NetworkTypestring

    实例的网络类型,取值:

    • Classic:经典网络。
    • VPC:VPC 网络。
    Classic
    EngineVersionstring

    实例的引擎版本,取值为 5.04.44.24.03.4

    4.0
    InstanceClassstring

    实例规格。不同类型实例的规格分别请参见:

    说明 Serverless 实例不需要传入该参数。
    dds.mongo.2xlarge
    VpcIdstring

    专有网络 ID。

    vpc-bp1nme44gek34slfc****
    VSwitchIdstring

    虚拟交换机 ID。

    vsw-bp1e7clcw529l773d****
    InstanceTypestring

    实例类型,取值:

    • sharding:分片集群实例。

    • replicate:副本集实例和单节点实例。

    • serverless:Serverless 实例。

    说明
  • 请根据实际需求配置,例如您需要查询分片集群实例的概览,则配置该参数的值为 sharding
  • 不配置该参数时,默认查询所有实例的概览。
  • replicate
    ZoneIdstring

    可用区 ID。

    cn-hangzhou-b
    ResourceGroupIdstring

    资源组 ID。资源组详情请参见查看资源组基本信息

    rg-acfmyiu4ekp****

    返回参数

    名称类型描述示例值
    object

    实例概览信息。

    TotalCountstring

    查询结果中实例的数量。

    1
    RequestIdstring

    请求 ID。

    52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA
    DBInstancesobject []

    实例信息列表。

    CreationTimestring

    实例创建的时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

    2022-01-05T03:18:53Z
    ExpireTimestring

    实例到期时间,格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。

    2022-02-05T16:00Z
    Tagsobject []

    实例的标签信息。

    Keystring

    实例的标签键。N 的取值范围为 1~20

    • 不能以aliyunacs:http://https://开头。
    • 最多支持 64 个字符。
    • 不允许传入空字符串。
    testdatabase
    Valuestring

    实例的标签值。N 的取值范围为 1~20

    • 不能以aliyunacs:、http://https://开头。
    • 最多支持 128 个字符。
    • TagValue 可以为空。
    apitest
    LastDowngradeTimestring

    实例最后一次降配时间。

    2021-05-08
    ShardListobject []

    Shard 节点信息列表。

    说明 实例类型为分片集群实例时返回该参数。
    NodeClassstring

    Shard 节点的规格。

    dds.shard.mid
    NodeDescriptionstring

    Shard 节点的描述信息。

    测试shard节点
    NodeStorageinteger

    Shard 节点的存储空间,单位为 GB。

    10
    NodeIdstring

    Shard 节点的 ID。

    d-bp1cac6f2083****
    ReadonlyReplicasinteger

    Shard 节点中只读节点的个数。返回值范围:0~5

    2
    DBInstanceTypestring

    实例类型,取值:

    • sharding:分片集群实例。

    • replicate:副本集实例和单节点实例。

    • serverless:Serverless 实例。

    replicate
    DestroyTimestring

    实例数据销毁时间,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

    2021-12-10T16:00:00Z
    ChargeTypestring

    实例付费类型,取值:

    • PrePaid:预付费,包年包月。
    • PostPaid:按量付费。
    PrePaid
    CapacityUnitstring

    实例消耗的读写吞吐量。

    说明
  • 当实例类型为 Serverless 实例时返回该参数。
  • 仅中国站支持 Serverless 实例。
  • 100
    VpcAuthModestring

    是否开启了专有网络免密访问功能。取值:

    • Open:开启。
    • Close:关闭。
    Open
    DBInstanceStatusstring

    实例的状态信息,取值详情请参见实例状态表

    Running
    NetworkTypestring

    实例网络类型,取值:

    • Classic:经典网络。
    • VPC:VPC 网络。
    VPC
    LockModestring

    实例的锁定状态。

    • Unlock:正常。
    • ManualLock:手动触发锁定。
    • LockByExpiration:实例过期自动锁定。
    • LockByRestoration:实例回滚前自动锁定。
    • LockByDiskQuota:实例空间满自动锁定。
    • Released:实例已释放。此时实例无法进行解锁,只能使用备份数据重新创建新实例,重建时间较长,请耐心等待。
    Unlock
    EngineVersionstring

    实例的数据库版本。

    4.2
    MongosListobject []

    Mongos 节点信息列表。

    说明 实例类型为分片集群实例时返回该参数。
    NodeClassstring

    Mongos 节点规格。

    dds.mongos.standard
    NodeDescriptionstring

    Mongos 节点描述。

    测试mongos节点
    NodeIdstring

    Mongos 节点 ID。

    s-bp10e3b0d02f****
    RegionIdstring

    实例所属地域 ID。

    cn-hangzhou
    DBInstanceStorageinteger

    实例的存储空间大小,单位为 GB。

    20
    ResourceGroupIdstring

    实例所属资源组 ID。

    rg-acfm22cdcgc****
    ZoneIdstring

    实例所属可用区。

    cn-hangzhou-i
    DBInstanceIdstring

    实例 ID。

    dds-bp12c5b040dc****
    DBInstanceClassstring

    实例规格。不同类型实例的规格分别请参见:

    说明 Serverless 实例不需要传入该参数。
    dds.mongo.mid
    Enginestring

    数据库引擎,取值为 MongoDB

    MongoDB
    ReplicationFactorstring

    实例中节点的个数。

    说明 实例类型为副本集实例时返回该参数。
    3
    DBInstanceDescriptionstring

    实例的描述或备注信息。

    测试数据库
    KindCodestring

    表示实例的类型。取值:

    • 0:物理机
    • 1:ECS
    • 2:DOCKER
    • 18:k8s 新架构实例
    0

    示例

    正常返回示例

    JSON格式

    {
      "TotalCount": "1",
      "RequestId": "52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA",
      "DBInstances": [
        {
          "CreationTime": "2022-01-05T03:18:53Z",
          "ExpireTime": "2022-02-05T16:00Z",
          "Tags": [
            {
              "Key": "testdatabase",
              "Value": "apitest"
            }
          ],
          "LastDowngradeTime": "2021-05-08",
          "ShardList": [
            {
              "NodeClass": "dds.shard.mid",
              "NodeDescription": "测试shard节点",
              "NodeStorage": 10,
              "NodeId": "d-bp1cac6f2083****",
              "ReadonlyReplicas": 2
            }
          ],
          "DBInstanceType": "replicate",
          "DestroyTime": "2021-12-10T16:00:00Z",
          "ChargeType": "PrePaid",
          "CapacityUnit": "100",
          "VpcAuthMode": "Open",
          "DBInstanceStatus": "Running",
          "NetworkType": "VPC",
          "LockMode": "Unlock",
          "EngineVersion": "4.2",
          "MongosList": [
            {
              "NodeClass": "dds.mongos.standard",
              "NodeDescription": "测试mongos节点",
              "NodeId": "s-bp10e3b0d02f****"
            }
          ],
          "RegionId": "cn-hangzhou",
          "DBInstanceStorage": 20,
          "ResourceGroupId": "rg-acfm22cdcgc****",
          "ZoneId": "cn-hangzhou-i",
          "DBInstanceId": "dds-bp12c5b040dc****",
          "DBInstanceClass": "dds.mongo.mid",
          "Engine": "MongoDB",
          "ReplicationFactor": "3",
          "DBInstanceDescription": "测试数据库",
          "KindCode": "0"
        }
      ]
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2022-01-11新增 OpenAPI看变更集
    • 本页导读 (1)
    文档反馈