# 查询实例备份信息
#### 功能介绍
查询指定缓存实例的备份信息列表。
#### **URI**
GET /v1.0/{project_id}/instances/{instance_id}/backups?start={start}\&limit={limit}\&beginTime={beginTime}\&endTime={endTime}
参数说明见[表1]。
 表1参数说明 
| 参数         | 类型       | 必选 | 说明                                         |
|:---|:---|:---|:---|
| project_id  | String   | 是   | 项目ID。                                       |
| instance_id | String  | 是     | 实例ID。                                      |
| start         | Integer   | 否     | 待查询的备份记录的起始序号，默认起始序号为1。                     |
| limit        | Integer | 否   | 每页显示条数，最小值为1，若不设置该参数，默认显示10条。               |
| beginTime    | String    | 否    | 查询开始时间。格式：yyyyMMddHHmmss，如：20170718235959。  |
| endTime    | String  | 否   | 查询结束时间。格式：yyyyMMddHHmmss，如：20170718235959。 |
   
#### **请求消息**
**请求参数**
无
**请求示例**
```
GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}
```
#### **响应消息**
**响应参数**
参数说明见[表2]。
 表2参数说明 
| 参数                      | 类型   | 说明                                                     |
|:---|:---|:---|
| backup_record_response | Array | 备份信息的详情数组，具体请参考[表3]。 |
| total_num              | Integer  | 返回记录数。                                                   |
   
 表3backup_record_response参数说明 
| 参数                | 类型      | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|
| status             | String   | 备份状态。 - waiting：等待中。  - backuping：备份中。  - succeed：备份成功。  - failed：备份失败。  - expired：备份文件过期。  - deleted：已手动删除备份文件。   |
| remark             | String  | 备份缓存实例的备注信息。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| period             | String  | 备份执行时间段。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| progress          | String  | 备份进度。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| size                 | Long    | 备份文件大小（Byte）。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| instance_id        | String | 实例ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| backup_id           | String  | 备份ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| created_at       | String  | 备份任务创建时间。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| updated_at        | String  | 备份完成时间。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| execution_at      | String   | 备份任务执行时间。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| backup_type      | String   | 备份类型。 - manual：表示备份类型为手动备份  - auto：表示备份类型为自动备份                                                                                                                                                                                                                                                                                                                                                          |
| backup_name        | String | 备份记录名称。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| error_code       | String | 备份失败后错误码，参见[表4]。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| is_support_restore | String  | 是否可以进行恢复操作，取值为TRUE或FALSE。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
   
 表4DCS备份恢复错误码 
| 错误码          | 说明                  |
|:---|:---|
| dcs.08.0001   | 启动备份恢复工具失败。          |
| dcs.08.0002 | 执行超时。                |
| dcs.08.0003   | 删除桶失败。                |
| dcs.08.0004 | 获取ak/sk失败。           |
| dcs.08.0005 | 创建桶失败。                |
| dcs.08.0006  | 查询备份数据大小失败。         |
| dcs.08.0007 | 恢复时同步数据失败。           |
| dcs.08.0008  | 自动备份任务未运行，实例正在运行其他任务。 |
   
**响应示例**
```
{
    "backup_record_response": [
        {
            "status": "succeed",
            "remark": "001",
            "period": null,
            "progress": "100.00",
            "size": 880232,
            "instance_id": "5560df16-cebf-4473-95c4-d1b573c16e79",
            "backup_id": "4631832a-14c6-45b0-a0b3-3abd8f591ad1",
            "created_at": "2019-05-10T08:31:16.166Z",
            "updated_at": "2019-05-10T08:32:30.546Z",
            "execution_at": "2019-05-10T08:31:21.461Z",
            "backup_type": "manual",
            "backup_name": "backup_20190510163116",
            "error_code": null,
            "is_support_restore": "TRUE"
        }
    ],
    "total_num": 1
}
```
#### **状态码**
操作成功的状态码如[表5]所示，其他响应见[表1](https://support.huaweicloud.com/api-dcs/dcs-api-0312043.html#dcs-api-0312043__table5210141351517)。
 表5状态码 
| 状态码 | 描述         |
|:---|:---|
| 200 | 查询缓存实例备份信息成功。 |