
# 查询数据库列表-QueryingDatabases
#### 接口说明
查询数据库列表。
#### 约束说明
- 该接口只支持DDS社区版。
- 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非"normal"时，不允许执行该操作。
 
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DDS/doc?api=ListDatabases)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                       | 访问级别 | 资源类型（\*为必须） | 条件键                                                                                                              | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | dds:instance:getDatabases | read | instance    | [g:EnterpriseProjectId](https://support.huaweicloud.com/api-dds/dds_api_0042.html#dds_api_0042__li1539015369314) | -  | -      |
     
  
 
#### URI
- URI格式 GET /v3/{project_id}/instances/{instance_id}/databases
  
- URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/*0549b4a43100d4f32f51c01c2fe4acdb/instances/659914406d2c4c76bce6a028ce8d8e0din02/databases?offset=1\&limit=10*
  
 
表1请求参数 
| 名称           | 类型      | IN     | 是否必选 | 描述                                                                                                                                                                                                                         |
|:---|:---|:---|:---|:---|
| X-Auth-Token | string  | header | 是    | 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。                                                                                                                                     |
| project_id   | string  | path   | 是    | 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。                                                                                                                         |
| instance_id  | string  | path   | 是    | 实例ID，可以调用"[查询实例列表和详情-QueryingInstancesandDetails](https://support.huaweicloud.com/api-dds/dds_api_0023.html)"接口获取。如果未申请实例，可以调用"[创建实例-CreatingaDBInstance](https://support.huaweicloud.com/api-dds/dds_api_0020.html)"接口创建。 |
| offset       | Integer | path   | 否    | 索引位置偏移量。 取值大于或等于0。不传该参数时，查询偏移量默认为0。                                                                                                                                                           |
| limit        | Integer | path   | 否    | 查询个数上限值。 取值范围：1\~100。不传该参数时，默认查询前100条实例信息。                                                                                                                                                   |
   
#### 请求消息
无。
#### 响应消息
- 参数说明
  表2响应Body参数 
  | 名称          | 参数类型             | 描述                                                   |
  |:---|:---|:---|
  | databases   | Array of objects | 数据库信息列表。请参考[表3]。 |
  | total_count | Integer          | 总数。                                                  |
     
   表3databases 
  | 参数             | 参数类型    | 描述                                                             |
  |:---|:---|:---|
  | 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 
  }
  ```
  
 
#### SDK
单击[文档数据库服务 DDS SDK](https://sdkcenter.developer.huaweicloud.com/?product=DDS)，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
#### 状态码
详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。
#### 错误码
详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。
