更新备份策略

接口URL

/api/v1/dms/br/policies/{policyID}

请求方式

PUT

Content-Type

application/json

认证方式

Bearer auth

路径变量

参数名	示例值	参数描述
policyID	p-73189323	policy id

请求Body参数

{
    "AccessKeyID": "miniotem",
    "ClusterIDs": [
        "tidb-f91e1f860d360502"
    ],
    "Cycle": 0,
    "Destination": "s3://tem/br/tidb-test?endpoint=http://172.16.6.62:9999&force-path-style=true",
    "Frequency": "0,1,2,3,4",
    "LogBackup": true,
    "Name": "weekdayBackup",
    "Retention": 7,
    "SecretAccessKey": "miniotem",
    "Time": "03:00",
    "Concurrency": 2,
    "LogFile": "/tmp/weekdayBackupV2.log",
    "RateLimit": 1
}

参数名	示例值	参数类型	是否必填	参数描述
AccessKeyID	-	String	否	仅当存储类型是 s3 时需要
ClusterIDs	-	Array	否	备份策略关联的集群 ID 列表
Cycle	-	Integer	否	备份周期单位，0 代表周，1 代表月
Destination	-	String	否	可以参考样例填写 s3 路径，或者如果是本地 nfs 挂载路径可以填写如 local:///tmp/backup
Frequency	-	String	否	当备份周期为周时，可以填写0~6代表周一到周日；当周期为月时，可以填写1~31代表该月的几号
LogBackup	-	Boolean	否	是否开启日志备份
Name	-	String	否	备份策略名称
Retention	0	Integer	否	备份保留时间，单位为天
SecretAccessKey	-	String	否	仅当存储类型是 s3 时需要
Time	02:00	String	否	备份调度时间
Concurrency	2	Integer	是	备份或恢复阶段的任务并发数
LogFile	/tmp/weekdayBackupV2.log	String	是	BR log 写入的目标文件，默认在 /tmp 目录下
RateLimit	1	Integer	是	每个 TiKV 执行备份任务的速度上限（单位 MiB/s）

成功响应示例

{
    "Data": null,
    "Success": true
}

参数名	示例值	参数类型	参数描述
code	-	String
message	-	String
success	-	Boolean

results matching ""

No results matching ""