文档首页/ 文档数据库服务 DDS/ API参考（联盟区域）/ API v3（推荐）/ 管理数据库和用户/ 查询数据库列表
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

查询数据库列表

接口说明

查询数据库列表。

约束说明

  • 该接口只支持DDS社区版。
  • 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非“normal”时，不允许执行该操作。

URI

  • URI格式

    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/databases?offset={offset}&limit={limit}

表1 参数说明

名称

类型

IN

是否必选

描述

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

offset

Integer

path

否

索引位置偏移量。

取值大于或等于0。不传该参数时，查询偏移量默认为0。

limit

Integer

path

否

查询个数上限值。

取值范围：1~100。不传该参数时，默认查询前100条实例信息。

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。

响应参数

表3 响应Body参数

名称

参数类型

描述

databases

Array of objects

数据库信息列表。请参考表4。

total_count

Integer

总数。
表4 databases

参数

参数类型

描述

name

String

数据库名称, config admin 库不做展示。

data_size

String

数据库逻辑大小（以GB为单位）,保留两位小数。逻辑大小指的是数据库中实际存储的数据大小，不包括索引大小、日志大小等。

storage_size

String

数据库存储大小（以GB为单位）,保留两位小数。存储大小: 实际磁盘上占用的物理空间大小，包括数据文件、日志文件、索引文件等。

collection_num

Integer

数据库中的集合数。
  • 响应示例 
    { 
  "databases" : [ { 
    "name" : "dds-test", 
    "data_size" : "3593", 
    "storage_size" : "256", 
    "collection_num" : "5" 
  } ], 
  "total_count" : 1 
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。