更新时间:2021-03-18 GMT+08:00
分享

修改备份策略

功能介绍

修改一个备份策略。

URI

  • URI格式

    PUT /v2/{project_id}/backuppolicy/{policy_id}

  • 参数说明

    参数

    是否必选

    描述

    project_id

    项目ID

    policy_id

    策略ID

请求

  • 参数说明

    参数

    是否必选

    参数类型

    描述

    backup_policy_name

    string

    备份策略名称。

    只能由数字、字母、汉字、下划线、中划线组成,同时不能以default开头,长度1到64位。

    默认备份策略名称不支持修改。

    scheduled_policy

    dict

    调度策略详情。

    start_time

    string

    备份开始时间,格式为HH:mm

    需要转化成本地时间对应的UTC时间(目前只支持整点),支持选择多个整点,多个整点间以逗号分隔。多个时间点启用备份时,请按照本地时间顺序编排,如UTC+02:00时区的00:00、02:00和04:00启动备份,转化为UTC时间后,start_time应取值“22:00,00:00,02:00”,time_zone取值"UTC+02:00"。

    frequency

    否(该字段和week_frequency字段必须二选一)

    integer

    备份间隔(1-14天),该字段和week_frequency字段二选一,如果同时设置,默认以该字段为准。

    week_frequency

    否(该字段和frequency字段必须二选一)

    list<string>

    按指定周进行备份,取值为以下值的一个或者多个:

    SUN,MON,TUE,WED,THU,FRI,SAT

    rentention_num

    integer

    备份保留个数,取值为2-14的整型,该字段和rentention_day字段如果同时设置,默认以该字段为准。

    rentention_day

    integer

    备份保留天数。取值为2-99999的整型,如果输入的是浮点数,则会在发送请求的时候自动向下取整转化为整型。

    remain_first_backup_of_curMonth

    string

    是否保留当月的第一个备份。

    • Y
    • N

    status

    string

    策略状态:启用或停用。

    • ON
    • OFF

    time_zone

    string

    时区参数。取值为UTC+/-HH:mm

    对应本地调度时间所在的时区,包含夏令时偏移。如UTC+08:00、UTC-02:00。当本地时间转化为UTC时间跨天后,需配合week_frequency、start_time字段使用。

  • 请求样例
    {
        "backup_policy_name": "policy_01",
        "scheduled_policy" : {
            "remain_first_backup_of_curMonth" : "Y",
            "rentention_num" : 10,
            "week_frequency" : ["MON"],
            "start_time" : "12:00",
            "status" : "ON"
        },
        "time_zone": "UTC+08:00"
    }

响应

  • 要素说明

    参数

    参数类型

    描述

    backup_policy_id

    string

    正常返回时,返回的策略ID。

    message

    string

    出现错误时,返回的错误消息。

    code

    string

    出现错误时,返回的错误码。

    错误码的具体含义请参考错误码

  • 响应样例
    {
      "backup_policy_id": "af8a20b0-117d-4fc3-ae53-aa3968a4f870"
    }

    {
        "error": {
            "code": "XXXX",
            "message": "XXX"
        }
    }

状态码

  • 正常

    200

  • 异常

    状态码

    说明

    400 Bad Request

    服务器未能处理请求。

    401 Unauthorized

    被请求的页面需要用户名和密码。

    403 Forbidden

    对被请求页面的访问被禁止。

    404 Not Found

    服务器无法找到被请求的页面。

    405 Method Not Allowed

    请求中指定的方法不被允许。

    406 Not Acceptable

    服务器生成的响应无法被客户端所接受。

    407 Proxy Authentication Required

    用户必须首先使用代理服务器进行验证,这样请求才会被处理。

    408 Request Timeout

    请求超出了服务器的等待时间。

    409 Conflict

    由于冲突,请求无法被完成。

    500 Internal Server Error

    请求未完成。服务异常。

    501 Not Implemented

    请求未完成。服务器不支持所请求的功能。

    502 Bad Gateway

    请求未完成。服务器从上游服务器收到一个无效的响应。

    503 Service Unavailable

    请求未完成。系统暂时异常。

    504 Gateway Timeout

    网关超时。

错误码

请参考错误码

相关文档