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

备份指定实例

功能介绍

备份指定的缓存实例。

只有主备和集群类型的缓存实例支持备份恢复操作，单机实例不支持备份恢复操作。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

实例ID。

project_id

是

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

remark

否

String

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

backup_format

否

String

备份缓存实例的格式。

枚举值：

  • aof

  • rdb

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

backup_id

String

备份记录ID。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 500

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

请求示例

备份指定的缓存实例，格式为aof。

POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/backups

{
  "remark" : "Backup instances",
  "backup_format" : "aof"
}

响应示例

状态码： 200

备份指定缓存实例成功。

{
  "backup_id" : "548ceeff-2cbb-47ab-9a1c-7b085a8c08d7"
}

状态码

状态码

描述

200

备份指定缓存实例成功。

400

非法请求。

500

内部服务错误。

错误码

请参见错误码。

父主题： 备份与恢复