文档首页/分布式缓存服务 DCS/API参考（巴黎区域）/API V2（推荐）/备份与恢复/查询实例恢复记录
更新时间：2023-12-13 GMT+08:00
查看PDF
分享

查询实例恢复记录

功能介绍

查询指定缓存实例的恢复记录列表。

URI

GET /v2/{project_id}/instances/{instance_id}/restores

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

实例ID。

project_id

是

String

项目ID。获取方法请参见获取项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

begin_time

否

String

查询开始时间。格式：yyyyMMddHHmmss，如：20170718235959。

end_time

否

String

查询结束时间。格式：yyyyMMddHHmmss，如：20170718235959。

limit

否

Integer

每页显示的条目数量。

offset

否

Integer

偏移量，表示从此偏移量开始查询， offset大于等于0。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

restore_record_response

Array of InstanceRestoreInfo objects

实例恢复记录的详情数组。

total_num

Integer

总数量。

表4 InstanceRestoreInfo

参数

参数类型

描述

backup_id

String

备份记录ID。

restore_id

String

恢复记录ID。

backup_name

String

备份记录名称。

updated_at

String

恢复完成时间。

restore_remark

String

恢复备注信息。

created_at

String

恢复任务创建时间。

progress

String

恢复进度。

error_code

String

恢复失败后错误码。

  • 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 - 自动备份任务未运行，实例正在运行其他任务。

restore_name

String

恢复记录名称。

backup_remark

String

备份备注信息。

status

String

恢复状态。

  • waiting：等待中

  • restoring：恢复中

  • succeed：恢复成功

  • failed：恢复失败

枚举值：

  • waiting

  • restoring

  • succeed

  • failed

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

请求示例

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/restores?offset={offset}&limit={limit}&begin_Time={begin_Time}&end_Time={end_Time}

响应示例

状态码： 200

查询实例恢复记录成功。

{
  "restore_record_response" : [ {
    "backup_id" : "f4823e9e-fe9b-4ffd-be79-4e5d6de272bb",
    "restore_id" : "a6155972-800c-4170-a479-3231e907d2f6",
    "backup_name" : "backup_20170718000002",
    "updated_at" : "2017-07-18T21:41:35.182Z",
    "restore_remark" : "doctest",
    "created_at" : "2017-07-18T21:41:20.721Z",
    "progress" : "100.00",
    "error_code" : { },
    "restore_name" : "restore_20170718214120",
    "backup_remark" : { },
    "status" : "succeed"
  } ],
  "total_num" : 1
}

状态码

状态码

描述

200

查询实例恢复记录成功。

204

查询实例恢复当前无记录。

400

非法请求。

错误码

请参见错误码。

父主题：备份与恢复