接口介绍
通过接口修改备份计划
接口约束
1、用户自定义备份计划名称,只能由数字、字母、-组成,不能以数字和-开头、且不能以-结尾 备份计划名称长度不超过64个字符
2、设置被保护云主机上需要备份的文件目录,提供三种配置模式:全部目录、指定目录、高级规则。 a)全部目录:备份该云主机上所有目录 ,不会备份/dev、/proc、/sys及其子目录。 b)指定目录:用户可以自己手动输入添加需要备份的目录,最多可以添加10条 + 路径选择,是绝对路径,不能包含/dev、/proc、/sys及其子目录,不支持通配符 c)高级规则:用户可以自己手动输入添加需要备份的目录,最多10条。同时可以通过备份文件规则选择包括所有文件、包含下列文件、排除下列文件。三种规则只能选择其中一种执行。包含和排除文件需要用户手动输入路径或者文件,路径选择是绝对路径,不能包含/dev、/proc、/sys及其子目录,不支持通配符
3、配置保留备份副本的时间。时间单位为天、周、月、年。 保留时长设置不能小于备份周期,即备份副本最少要可保留一个。最小保留周期为1天,最大输入999年、11988月、51948周、364635天
URI
POST /v4/backup/update-backup-policy
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 |
---|---|---|---|
regionID | 是 | String | 资源池ID, 例:100054c0416811e9a6690242ac110002 |
backupPolicyID | 是 | String | 备份计划ID |
backupPolicyName | 是 | String | 备份计划名字 |
directType | 是 | Integer | 备份目录规则 0: 全部目录 1:指定目录 2:高级规则 |
backupFileInfo | 否 | Object | 备份文件信息 参考BackupFileInfo表 |
backupPeriodInfo | 是 | Object | 备份时间信息 参考BackupPeriodInfo表 |
backupRetentionInfo | 是 | Object | 备份保留信息 参考BackupRetentionInfo表 |
BackupFileInfo表
参数 | 是否必填 | 参数类型 | 说明 |
---|---|---|---|
dirs | 否 | Array of String | 目录列表,最多10个 备份路径的长度不超过4096个字符,单目录名不能超过255个字符。 --如果目录规则不是全部目录则必填-如若填写则校验参数类型 |
files | 否 | Array of String | 文件列表,备份路径的长度不超过4096个字符,单目录名不能超过255个字符。 --如果文件规则不是全部文件则必填-如若填写则校验参数类型 |
rule | 否 | Integer | 备份文件规则,0:全部文件,1:包含文件files,2:排除文件files --如果目录规则是高级规则则必填-如若填写则校验参数类型 |
BackupPeriodInfo表
参数 | 是否必填 | 参数类型 | 说明 |
---|---|---|---|
rule | 是 | Integer | 备份时间规则:0 : 每小时备份一次 1 : 每天备份一次 2 : 每周备份一次 3 : 每月备份一次 |
day | 否 | Integer | 星期:day取值范围[0, 6],0表示周日,1~6分别表示周一至周六,日期:day取值范围[1, 31]--时间规则为每周跟每月必填,其他规则填写无效-如若填写则校验参数类型 |
hour | 否 | Integer | 小时 取值范围[0,23] --除了时间规则为每小时不是必填,其他规则时都是必填-如若填写则校验参数类型 |
BackupRetentionInfo表
参数 | 是否必填 | 参数类型 | 说明 |
---|---|---|---|
type | 是 | Integer | -1: 永久保留 1:天 2:周 3:月 4:年 |
value | 否 | Integer | 保留时间--如果不是永久保留则必填-如若填写则校验参数类型 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为失败) | 参考响应示例 | |
message | 是 | String | 失败时的错误描述,一般为英文描述 | 参考响应示例 | |
description | 是 | String | 失败时的错误描述,一般为中文描述 | 参考响应示例 | |
returnObj | 是 | Object | 修改备份计划任务下发状态 | 参考returnObj表 | |
detail | 是 | String | 详细的错误信息。 | 参考响应示例 |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
msg | 是 | String | 修改备份计划任务下发描述 | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"backupPolicyID": "31f777-827f25f-595ffa3-deb5d15d"
"backupPolicyName": "storage-1",
"backupSrcInstanceID": "341f648-27f77f46-8595ffa-deb5d15d",
"backupStorageID": "541f648-27f77f-76648898-82937",
"directType": 2,
"backupFileInfo": {
"dirs":[
"/yacos",
"/openapi"
],
"files":[
"/home/yacos/app.py"
]
},
"backupPeriodInfo": {
"rule": 2,
"day": 6,
"hour": 21
},
"backupRetentionInfo": {
"type": 2,
"value": 111
},
}
响应示例
{
"description" : "\u6210\u529f",
"details" : "",
"message" : "SUCCESS",
"returnObj" : {
"msg" : "backupPolicy was updated successfully.",
},
"statusCode" : 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
错误码
请参考状态码