接口功能介绍

通过接口修改备份计划

接口约束

1、用户自定义备份计划名称，只能由数字、字母、-组成，不能以数字和-开头、且不能以-结尾，备份计划名称长度不超过64个字符

2、设置被保护主机上需要备份的文件目录，提供三种配置模式：全部目录、指定目录、高级规则。 a)全部目录：备份该主机上所有目录 ，不会备份/dev、/proc、/sys及其子目录。 b)指定目录：用户可以自己手动输入添加需要备份的目录，最多可以添加10条 + 路径选择，是绝对路径，不能包含/dev、/proc、/sys及其子目录，不支持通配符 c)高级规则：用户可以自己手动输入添加需要备份的目录，最多10条。同时可以通过备份文件规则选择包括所有文件、包含下列文件、排除下列文件，最多10条。三种规则只能选择其中一种执行。包含和排除文件需要用户手动输入路径或者文件,路径选择是绝对路径，不能包含/dev、/proc、/sys及其子目录，单条备份路径的字符最长为4095

3、配置保留备份副本的时间或数量，也可永久保留。单位为天、周、月、年、个。 保留时长设置不能小于备份周期，即备份副本最少要可保留一个。最小保留周期为1天或1个，最大输入999年、11988月、51948周、364635天、2000个，高级保留策略配置项取值范围为0-100

4、客户端版本在2.3.0开始支持通配符且目录路径与文件路径分别只允许出现一个使用通配符的路径： 支持*通配符，代表所有字符，如/home/*.txt代表以/home/下面所有.txt结尾的文件 支持？通配符，代表任意1个字符，如/home/a?c, 代表如/home/abc, /home/acc 支持[] 通配符，代表匹配字符范围，如/home/[a-z]代表home下面所有a-z 的路径 支持[^] 匹配，代表匹配字符不在[]范围内，如/home/[^a-z] 代表所有不是小写字符的路径 支持以上通配符组合，如/home/[a-z]*，代表所有以/home 下面，所有a-z 开头的路径

URI

POST /v4/backup/update-backup-policy

路径参数 无

Query参数 无

请求参数

请求头header参数 无

请求体body参数

表 backupLimitQosInfo

表 rateLimits

表 backupFileInfo

表 backupPeriodInfo

表 backupRetentionInfo

表 backupFullInfo

表 conf

响应参数

表 returnObj

枚举参数

无

请求示例

请求url

无

请求头header

无

请求体body

{
    "regionID": "41f64827f25f468595ffa3a5deb5d15d",
    "backupPolicyID": "31f777-827f25f-595ffa3-deb5d15d",
    "backupPolicyName": "storage-1",
    "directType": 2,
    "backupFileInfo": {
        "dirs":[
            "D:\\"
        ],
        "files":[
            "/dev/app.py"
        ],
        "rule":0
    },
    "backupPeriodInfo": {
        "rule": 2,
        "day": 1,
        "hour": 0
    },
    "backupRetentionInfo": {
        "type": -4,
        "value":30,
        "hasConf":true,
        "conf":{
            "day":1,
            "week":0,
            "month":1,
            "year":100
        }
    },
    "backupFullInfo":{
        "backupMode":0,
        "incrementNum":11
    },
    "backupLimitQosInfo":{
        "isLimitQos":true,
        "rateLimits":[
            {
                "start":0,
                "stop":23,
                "uploadMb":100
            }
        ]
    },
    "sourceType": "CT-LS"
}

响应示例

{
  "httpstatus": 200,
  "httpresult": {
    "returnObj": {
      "status": "success",
      "msg": "backupPolicy updated success"
    },
    "message": "SUCCESS",
    "description": "成功",
    "statusCode": 800
  }
}

状态码

请参考 状态码

错误码

请参考 错误码