首页 云数据库 MongoDB API参考指南 API目录 查询实例 DescribeDBInstancesOverview - 查询实例的概览信息

DescribeDBInstancesOverview - 查询实例的概览信息

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

接口说明

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

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

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
RegionId string 是

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

 cn-hangzhou
InstanceIds string 否

需要查询概览的实例ID。

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

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

    		 Running
    ChargeType string 否

    实例的付费类型，取值：

    • PrePaid：预付费，包年包月。
    • PostPaid：按量付费。
    		 PostPaid
    NetworkType string 否

    实例的网络类型，取值：

    • Classic：经典网络。
    • VPC：VPC网络。
    		 Classic
    EngineVersion string 否

    实例的引擎版本，取值为 5.0、4.4、 4.2、4.0或 3.4。

    		 4.0
    InstanceClass string 否

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

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

    专有网络ID。

    		 vpc-bp1nme44gek34slfc****
    VSwitchId string 否

    虚拟交换机ID。

    		 vsw-bp1e7clcw529l773d****
    InstanceType string 否

    实例类型，取值：

    • sharding：分片集群实例。

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

    • serverless：Serverless实例。

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

    可用区ID。

    		 cn-hangzhou-b
    ResourceGroupId string 否

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

    		 rg-acfmyiu4ekp****

    返回参数

    名称 类型 描述 示例值
    object

    实例概览信息。
    TotalCount string

    查询结果中实例的数量。

    		 1
    RequestId string

    请求ID。

    		 52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA
    DBInstances array

    实例信息列表。
    object

    实例信息列表。
    CreationTime string

    实例创建的时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

    		 2022-01-05T03:18:53Z
    ExpireTime string

    实例到期时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。

    		 2022-02-05T16:00Z
    Tags array

    实例的标签信息。
    object

    实例的标签信息。
    Key string

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

    • 不能以aliyun、acs:、http://或https://开头。
    • 最多支持64个字符。
    • 不允许传入空字符串。
    		 testdatabase
    Value string

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

    • 不能以aliyun、acs:、http://或https://开头。
    • 最多支持128个字符。
    • TagValue可以为空。
    		 apitest
    LastDowngradeTime string

    实例最后一次降配时间。

    		 2021-05-08
    ShardList array

    Shard节点信息列表。

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

    Shard节点信息列表。

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

    Shard节点的规格。

    		 dds.shard.mid
    NodeDescription string

    Shard节点的描述信息。

    		 测试shard节点
    NodeStorage integer

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

    		 10
    NodeId string

    Shard节点的ID。

    		 d-bp1cac6f2083****
    ReadonlyReplicas integer

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

    		 2
    DBInstanceType string

    实例类型，取值：

    • sharding：分片集群实例。

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

    • serverless：Serverless实例。

    		 replicate
    DestroyTime string

    实例数据销毁时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

    		 2021-12-10T16:00:00Z
    ChargeType string

    实例付费类型，取值：

    • PrePaid：预付费，包年包月。
    • PostPaid：按量付费。
    		 PrePaid
    CapacityUnit string

    实例消耗的读写吞吐量。

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

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

    • Open：开启。
    • Close：关闭。
    		 Open
    DBInstanceStatus string

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

    		 Running
    NetworkType string

    实例网络类型，取值：

    • Classic：经典网络。
    • VPC：VPC网络。
    		 VPC
    LockMode string

    实例的锁定状态。

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

    实例的数据库版本。

    		 4.2
    MongosList array

    Mongos节点信息列表。

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

    Mongos节点信息列表。

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

    Mongos节点规格。

    		 dds.mongos.standard
    NodeDescription string

    Mongos节点描述。

    		 测试mongos节点
    NodeId string

    Mongos节点ID。

    		 s-bp10e3b0d02f****
    RegionId string

    实例所属地域ID。

    		 cn-hangzhou
    DBInstanceStorage integer

    实例的存储空间大小。

    		 20
    ResourceGroupId string

    实例所属资源组ID。

    		 rg-acfm22cdcgc****
    ZoneId string

    实例所属可用区。

    		 cn-hangzhou-i
    DBInstanceId string

    实例ID。

    		 dds-bp12c5b040dc****
    DBInstanceClass string

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

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

    数据库引擎，取值为MongoDB。

    		 MongoDB
    ReplicationFactor string

    实例中节点的个数。

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

    实例的描述或备注信息。

    		 测试数据库
    KindCode string

    表示实例的类型。取值：

    • 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
    阿里云首页 云数据库 MongoDB 版 相关技术圈