接口功能介绍

修改、启用、停用云主机备份策略

接口约束

1.使用限制，本接口只支持在拉萨3、上海7、广州6、郴州2、长沙3、北京5、内蒙6、南京3、重庆2、合肥2、成都4、晋中、昆明2、乌鲁木齐27、福州25、衡阳3、长沙37、张家界2、华北2、央企北京1、华东1、上海32、上海33、上海36资源池进行公测
2.备份策略必须存在且可用状态
3.当修改云主机备份周期时，需要指定cycleType参数，当cycleType为week时表示按星期备份，必须指定备份周期cycleWeek；当cycleType为day时表示按天备份，必须指定备份周期cycleDay
4.当修改云主机备份保留类型时，需要指定retentionType参数，当retentionType为date表示按时间保留，必须指定保留天数retentionDay，当retentionType为num表示按数量保留，必须指定保留数量retentionNum

URI

POST /v4/ecs/backup-policy/update

路径参数
无

Query参数
无

请求参数

请求头header参数
无

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
regionID	是	String	资源池ID，您可以查看地域和可用区来了解资源池获取：查资源池列表查询	bb9fdb42056f11eda1610242ac110002
policyID	是	String	云主机备份策略ID，32字节获取：查查询云主机备份策略列表创创建云主机备份策略	d58bc64aa3b411edaf600242ac110009
policyName	否	String	云主机备份策略名称。满足以下规则：只能由数字、英文字母、中划线-、下划线_、点.组成，长度为2-64字符注：在所有资源池不可重复	test-bak
cycleType	否	String	云主机备份周期类型，取值范围：day（天），week（周）	day
cycleDay	否	Integer	备份周期（天），取值范围：[1, 30]，默认值为1 注：cycleType为day时需设置	1
cycleWeek	否	String	备份周期（星期），星期取值范围：0~6（代表周几，其中0为周日），默认值是0 注：只有cycleType为week时需设置；如果一周有多天备份，以逗号隔开（如周日周三进行快照，则填写"0,3"）	0,2,6
time	否	String	备份整点时间，时间取值范围：0~23 注：如果一天内多个时间节点备份，以逗号隔开（如11点15点进行快照，则填写"11,15"），默认值12	1,20
status	否	Integer	备份策略状态，是否启用，取值范围：0（不启用），1（启用）注：默认值0（不启用）	1
retentionType	否	String	云主机备份保留类型，取值范围：date（按时间保存），num（按数量保存），all（永久保存）	date
retentionDay	否	Integer	云主机备份保留天数，单位为天，取值范围：[1, 99999] ，默认值1 注：retentionType为date时必填	30
retentionNum	否	Integer	云主机备份保留数量，取值范围：[1, 99999]，默认值1 注：retentionType为num时必填	20
totalBackup	否	Boolean	全量备份，是否开启，取值范围：false（不启用），true（启用，备份执行全量备份），默认值为false。只有4.0资源池支持开启全量备份	false
advRetentionStatus	否	Boolean	是否开启高级保留策略，false（不启用），true(启用)，默认值为false。需校验云主机备份保留类型（retentionType），若保留类型为按数量保存（num），可开启高级保留策略；若保留类型为date（按时间保存）或all（永久保存），不可开启高级保留策略。	false
advRetention	否	Object	高级保留策略内容		advRetention

表 advRetention

参数	是否必填	参数类型	说明	示例
advDay	否	Integer	保留n天内、每天的第一个备份，n为输入的数字。单位为天，取值范围：[1, 99999]，默认值0	1
advWeek	否	Integer	保留n周内、每周的第一个备份，n为输入的数字。单位为周，取值范围：[1, 99999]，默认值0	1
advMonth	否	Integer	保留n月内、每月的第一个备份，n为输入的数字。单位为月，取值范围：[1, 99999]，默认值0	1
advYear	否	Integer	保留n年内、每年的第一个备份，n为输入的数字。单位为年，取值范围：[1, 99999]，默认值0	1

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码（800为成功，900为失败）	800
errorCode	String	错误码，为product.module.code三段式码	Openapi.PatternCheck.NotValid
error	String	错误码，为product.module.code三段式码	Openapi.PatternCheck.NotValid
message	String	错误信息的英文描述	SUCCESS
description	String	错误信息的本地化描述（中文）	成功
returnObj	Object	返回对象		returnObj

表 returnObj

参数	参数类型	说明	示例	下级对象
status	Integer	备份策略状态	1
policyName	String	备份策略名称	test-123
retentionType	String	云主机备份保留类型	date
retentionDay	Integer	保留时间，当retentionType为date时返回	2
retentionNum	Integer	保留数量，当retentionType为num时返回	2
regionID	String	资源池ID	81f7728662dd11ec810800155d307d5b
cycleType	String	备份周期类型	day
cycleDay	Integer	cycleType为day时返回备份周期值	2
cycleWeek	String	cycleType为week时返回备份周期值	4
policyID	String	云主机备份策略ID	03b2d47aa3ae11eda7ae0242ac110009
time	String	备份整点时间	3
projectID	String	企业项目ID	0
totalBackup	Boolean	全量备份，是否开启，取值范围：false（不启用），true（启用）。只有4.0资源池支持开启全量备份	false
advRetentionStatus	Boolean	是否开启高级保留策略，false（不启用），true(启用) 。	false
advRetention	Object	高级保留策略内容		advRetention

表 advRetention

参数	参数类型	说明	示例
advDay	Integer	保留n天内、每天的第一个备份，n为输入的数字。单位为天，取值范围：[1, 99999]，默认值0	1
advWeek	Integer	保留n周内、每周的第一个备份，n为输入的数字。单位为周，取值范围：[1, 99999]，默认值0	1
advMonth	Integer	保留n月内、每月的第一个备份，n为输入的数字。单位为月，取值范围：[1, 99999]，默认值0	1
advYear	Integer	保留n年内、每年的第一个备份，n为输入的数字。单位为年，取值范围：[1, 99999]，默认值0	1

枚举参数

无

请求示例

请求url

无

请求头header

无

请求体body

示例：修改云主机备份策略的名称为backup-01，备份周期为5天，12点整时进行备份，备份的保留类型为按数量保存，保留5份，备份策略状态为启用。
{
    "regionID":"bb9fdb42056f11eda1610242ac110002",
    "policyID":"bb1edb1a8b3811ed9af70242ac11000c",
    "policyName":"backup-01",
    "cycleType":"day",
    "cycleDay":5,
    "time":"12",
    "retentionType":"num",
    "retentionNum":5,
    "status":1
}

响应示例

{
    "returnObj": {
        "status": 1,
        "regionID": "bb9fdb42056f11eda1610242ac110002",
        "projectID": "0",
        "cycleDay": 5,
        "retentionNum": 20,
        "cycleType": "day",
        "policyID": "bb1edb1a8b3811ed9af70242ac11000c",
        "policyName": "backup-01",
        "retentionType": "num",
        "time": "12"
    },
    "message": "SUCCESS",
    "description": "成功",
    "statusCode": 800
}

状态码

请参考状态码

错误码

请参考错误码

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码