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

查询实例备份信息

功能介绍

查询指定缓存实例的备份信息列表。

URI

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

表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参数

参数

参数类型

描述

total_num

Integer

参数解释

实例备份返回记录数。

取值范围

不涉及。

backup_record_response

Array of BackupRecordResponse objects

参数解释

备份信息的详情数组。

表4 BackupRecordResponse

参数

参数类型

描述

backup_id

String

参数解释

备份记录ID。

取值范围

不涉及。

period

String

参数解释

备份执行时间段。

取值范围

不涉及。

backup_name

String

参数解释

备份记录名称。

取值范围

不涉及。

instance_id

String

参数解释

实例ID。

取值范围

不涉及。

size

Long

参数解释

备份文件大小(Byte)。

取值范围

不涉及。

backup_type

String

参数解释

备份类型。

取值范围

  • manual:表示备份类型为手动备份。

  • auto:表示备份类型为自动备份。

created_at

String

参数解释

备份任务创建时间。

取值范围

不涉及。

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

remark

String

参数解释

备份缓存实例的备注信息。

取值范围

不涉及。

status

String

参数解释

备份状态。

取值范围

  • waiting:等待中。

  • backuping:备份中。

  • succeed:备份成功。

  • failed:备份失败。

  • expired:备份文件过期。

  • deleted:已手动删除备份文件。

is_support_restore

String

参数解释

是否可以进行恢复操作。

取值范围

  • TRUE:可恢复。

  • FALSE:不可恢复。

execution_at

String

参数解释

执行时间。

取值范围

不涉及。

backup_format

String

参数解释

备份类型。

取值范围

  • aof

  • rdb

状态码: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}/backups?offset={offset}&limit={limit}&beginTime={begin_Time}&end_time={end_Time}

响应示例

状态码:200

查询缓存实例备份信息成功。

{
  "total_num" : 1,
  "backup_record_response" : [ {
    "period" : { },
    "backup_type" : "manual",
    "created_at" : "2019-05-10T08:31:16.166Z",
    "remark" : "001",
    "is_support_restore" : "TRUE",
    "backup_id" : "4631832a-14c6-45b0-a0b3-3abd8f591ad1",
    "backup_name" : "backup_20190510163116",
    "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79",
    "size" : 880232,
    "updated_at" : "2019-05-10T08:32:30.546Z",
    "progress" : "100.00",
    "error_code" : { },
    "status" : "succeed",
    "execution_at" : "2019-05-11T08:31:16.166Z",
    "backup_format" : "aof"
  } ]
}

状态码

状态码

描述

200

查询缓存实例备份信息成功。

204

查询缓存实例备份当前无记录。

400

非法请求。

500

内部服务错误。

错误码

请参见错误码