
# 查询DDM逻辑库列表
#### 功能介绍
查询DDM逻辑库列表。
#### 接口约束
无
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDM&api=ListDatabases)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### URI
GET /v1/{project_id}/instances/{instance_id}/databases?offset={offset}\&limit={limit}
表1路径参数 
| 参数          | 是否必选 | 参数类型   | 描述                                                                                                                                                        |
|:---|:---|:---|:---|
| project_id  | 是    | String | 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-ddm/ddm_api_01_0063.html)。 |
| instance_id | 是    | String | DDM实例ID。                                                                                                                                                  |
   
表2Query参数 
| 参数     | 是否必选 | 参数类型    | 描述                                                                                                                  |
|:---|:---|:---|:---|
| offset | 否    | Integer | 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0。 取值必须为数字，且不能为负数。 |
| limit  | 否    | Integer | 查询个数上限值。 取值范围：1\~128。 不传该参数时，默认值为128。           |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                   |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。 通过调用IAM服务的"获取用户Token"接口来获取。 |
   
#### 响应参数
**状态码： 200**
表4响应Body参数 
| 参数        | 参数类型                                                                           | 描述          |
|:---|:---|:---|
| databases | Array of [GetDatabaseInfo] objects | 逻辑库相关信息的集合。 |
| total     | Integer                                                                        | 总条数。        |
   
 表5GetDatabaseInfo 
| 参数           | 参数类型                                                                                 | 描述                                                                                                                                                                                                                                                                      |
|:---|:---|:---|
| name         | String                                                                               | 逻辑库名称。                                                                                                                                                                                                                                                                  |
| shard_mode   | String                                                                               | 逻辑库的工作模式。 - cluster表示逻辑库是拆分模式。  - single表示逻辑库是非拆分模式。   |
| shard_number | Integer                                                                              | 同一种工作模式下逻辑库分片的数量。                                                                                                                                                                                                                                                       |
| status       | String                                                                               | 逻辑库状态。                                                                                                                                                                                                                                                                  |
| created      | Long                                                                                 | 逻辑库的创建时间。                                                                                                                                                                                                                                                               |
| used_rds     | Array of [GetDatabaseUsedRds] objects | 逻辑库关联的RDS实例信息。                                                                                                                                                                                                                                                          |
| shard_unit   | Integer                                                                              | 单个RDS上的逻辑库分片数。                                                                                                                                                                                                                                                          |
   
 表6GetDatabaseUsedRds 
| 参数        | 参数类型   | 描述                  |
|:---|:---|:---|
| id        | String | 关联RDS节点ID。          |
| name      | String | 关联RDS名称。            |
| status    | String | 关联RDS状态。            |
| error_msg | String | 响应信息，若无异常信息则不返回该参数。 |
   
**状态码： 400**
表7响应Body参数 
| 参数              | 参数类型   | 描述     |
|:---|:---|:---|
| errCode         | String | 业务错误码。 |
| externalMessage | String | 错误信息。  |
   
**状态码： 500**
表8响应Body参数 
| 参数              | 参数类型   | 描述     |
|:---|:---|:---|
| errCode         | String | 业务错误码。 |
| externalMessage | String | 错误信息。  |
   
#### 请求示例
查询逻辑库列表。
```
GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/databases?offset={offset}&limit={limit}
```
#### 响应示例
**状态码： 200**
OK
```
{
  "databases" : [ {
    "status" : "RUNNING",
    "created" : 1642063713625,
    "name" : "mytestdb170",
    "shard_mode" : "cluster",
    "shard_number" : 8,
    "shard_unit" : 8,
    "used_rds" : [ {
      "id" : "c6f68fed9e74478c8679479a07d7d568in01",
      "status" : "normal",
      "name" : "rds-test"
    } ]
  } ],
  "total" : 172
}
```
**状态码： 400**
bad request
```
{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}
```
**状态码： 500**
server error
```
{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}
```
#### 状态码
| 状态码 | 描述           |
|:---|:---|
| 200 | OK           |
| 400 | bad request  |
| 500 | server error |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-ddm/ddm_api_01_0061.html)。
