CreateBackup--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

CreateBackup

最近更新时间：2024.07.18 22:55:10首次发布时间：2021.11.15 16:07:16

调用 CreateBackup 接口为目标 Redis 实例手动创建备份。

请求类型

异步请求。

注意事项

仅主备实例（即 InstanceClass 为 PrimarySecondary）支持调用该接口，单节点实例（即 InstanceClass 取值为 Standalone）不支持备份恢复相关操作，不支持调用该接口。关于两种类型实例的功能特性差异详情，请参见功能特性差异。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn02aqusft7ws****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
BackupPointName	String	否	testbackup	为手动创建的备份设置备份名称。如需设置备份名称，名称需同时满足如下条件: 以中文、字母、下划线（_）开头。长度为 1-128 个字符。由中文、字母、数字、下划线（_）和中划线（-）组成。说明若不设置备份名称，将默认使用创建备份任务时所生成的备份 ID 作为名称。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

参数	类型	示例值	描述
InstanceId	String	redis-cn02aqusft7ws****	实例 ID。
BackupPointId	String	b-cn02xmmrp751i9cdzcphjmk4****	创建备份任务时所生成的备份 ID。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=CreateBackup&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId":"redis-cn0212gzmh2xs****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202207271102110102252431250149****",
        "Action": "CreateBackup",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "BackupPointId": "b-cn02xmmrp751i9cdzcphjmk4****",
        "InstanceId": "redis-cn02aqusft7ws****"
    }
}

错误码

更多详情，请参见错误码。