更新时间:2025-11-14 GMT+08:00

查询实例恢复记录

功能介绍

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。可通过DCS控制台进入实例详情界面查看。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

begin_time

String

参数解释

查询开始时间。

约束限制

格式要求:yyyyMMddHHmmss,如:20170718235959。

取值范围

不涉及。

默认取值

不涉及。

end_time

String

参数解释

查询结束时间。

约束限制

格式要求:yyyyMMddHHmmss,如:20170718235959。

取值范围

不涉及。

默认取值

不涉及。

offset

Integer

参数解释

偏移量,表示生成的列表从此偏移量开始显示,例如偏移量为3时,生成的列表从第4条开始。

约束限制

不涉及。

取值范围

大于等于0。

默认取值

0

limit

Integer

参数解释

每页显示条数。

约束限制

不涉及。

取值范围

1~1000

默认取值

10

请求参数

响应参数

状态码: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

参数解释

恢复进度。

取值范围

0-100

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:恢复失败。

状态码:204

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

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

请求示例

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

非法请求。

500

内部服务错误。

错误码

请参见错误码