接口功能介绍

创建云硬盘备份策略

接口约束

无

URI

POST /v4/ebs-backup/policy/create

路径参数

无

Query参数

无

请求参数

请求头header参数

无

请求体body参数

参数	是否必填	参数类型	说明	示例
regionID	是	String	资源池ID	81f7728662dd11ec810800155d307d5b
policyName	是	String	策略名，唯一，不可重复，长度为 2~64 个字符，只能由中文字符、英文字母、数字、下划线、中划线组成	test-policy
status	否	Integer	是否启用策略，0-停用，1-启用，默认0	0
cycleType	是	String	备份周期类型，day-按天备份，week-按星期备份	day
cycleDay	否	Integer	备份周期，只有cycleType为day时需设置	1
cycleWeek	否	String	备份周期，只有cycleType为week时需设置，则取值范围0-6代表星期日-星期六，如果一周有多天备份，以逗号隔开	0,2,6
time	是	String	备份整点时间，取值范围0-23，如果一天内多个时间节点备份，以逗号隔开	1,20
retentionType	是	String	备份保留类型，num-按数量保留，date-按时间保留，all-全部保留	num
retentionNum	否	Integer	保留数量，只有retentionType为num时需设置,取值范围1-99999	1
retentionDay	否	Integer	保留天数，只有retentionType为date时需设置，取值1-99999	1
remainFirstOfCurMonth	否	Boolean	是否保留每个月第一个备份，在retentionType为num时可设置，默认false	false
projectID	否	String	企业项目ID，默认“0”	0

响应参数

参数	是否必填	类型	描述	示例	下级对象
statusCode	是	Integer	返回状态码（800为成功，900为失败）	800
message	是	String	错误信息的英文描述	SUCCESS
description	是	String	错误信息的本地化描述（中文）	成功
returnObj	否	Object	成功时返回对象		returnObj
errorCode	否	String	业务错误细分码，发生错误时返回	参考错误码

表 returnObj

参数名	是否必填	参数类型	说明	示例
regionID	是	String	资源池ID	81f7728662dd11ec810800155d307d5b
accountID	是	String	账户ID	562b89493b1a40e1b97ea05e50dd8170
status	是	Integer	状态，0-停用，1-启用	1
policyName	是	String	策略名	test-policy
cycleType	是	String	备份周期类型，day-按天备份，week-按星期备份	day
cycleDay	否	Integer	备份周期，只有cycleType为day时返回	1
cycleWeek	否	String	备份周期，只有cycleType为week时返回，则取值范围0-6代表星期日-星期六，如果一周有多天备份，以逗号隔开	0,2,6
time	是	String	备份整点时间，取值范围0-23，如果一天内多个时间节点备份，以逗号隔开	1,20
retentionType	是	String	备份保留类型，num-按数量保留，date-按时间保留，all-全部保留	num
retentionNum	否	Integer	保留数量，只有retentionType为num时返回	1
retentionDay	否	Integer	保留天数，只有retentionType为date时返回	1
remainFirstOfCurMonth	否	Boolean	是否保留每个月第一个备份，在retentionType为num时返回	false
projectID	是	String	企业项目ID	0

请求示例

请求体body

{
    "time": "0,4",
    "cycleType": "day",
    "cycleDay": 10,  
    "status": 1,
    "policyName": "test_from_test_script1666145616.64",
    "regionID": "81f7728662dd11ec810800155d307d5b",
    "remainFirstOfCurMonth": true,
    "retentionType": "num",
    "retentionNum": 9999
}

响应示例

{
    "returnObj": {
        "status": 1,
        "policyName": "test_from_test_script1666145616.64",
        "retentionType": "num",
        "remainFirstOfCurMonth": true,
        "regionID": "81f7728662dd11ec810800155d307d5b",
        "cycleDay": 10,
        "retentionNum": 11,
        "cycleType": "day",
        "time": "0",
        "accountID": "552b89493b1a40e1b97ea05e50dd8170",
        "projectID": "0"
    },
    "message": "SUCCESS",
    "description": "成功",
    "statusCode": 800
}

错误码

errorCode	描述
EbsBackup.RegionInfo.Empty	查询资源池信息为空或资源池不存在，请确认资源池ID是否有效
EbsBackup.RegionInfo.AccessFailed	查询资源池失败，请重试。如果多次尝试失败，请提交工单
EbsBackup.RegionInfo.DataDamaged	查询资源池信息不符预期，请重试。如果多次尝试失败，请提交工单
EbsBackup.Parameter.InvalidPolicyName	请求参数错误：{错误原因}
EbsBackup.Parameter.InvalidPolicyID	请求参数错误：{错误原因}
EbsBackup.Parameter.InvalidCycleType	请求参数错误：{错误原因}
EbsBackup.Parameter.InvalidCycleDay	请求参数错误：{错误原因}
EbsBackup.Parameter.InvalidCycleWeek	请求参数错误：{错误原因}
EbsBackup.Parameter.InvalidTime	请求参数错误：{错误原因}
EbsBackup.Parameter.InvalidRetentionType	请求参数错误：{错误原因}
EbsBackup.Parameter.InvalidRetentionDay	请求参数错误：{错误原因}
EbsBackup.Parameter.InvalidRetentionNum	请求参数错误：{错误原因}
EbsBackup.Parameter.InvalidRegionID	请求参数错误：{错误原因}
EbsBackup.Parameter.InvalidRemainFirstOfCurMonth	请求参数错误：{错误原因}
EbsBackup.Parameter.InvalidStatus	请求参数错误：{错误原因}
EbsBackup.PolicyInfo.OverQuota	超过配额{quota}
EbsBackup.OrderCheck.InvalidProjectID	企业项目不存在，请确认企业项目ID是否有效

云硬盘备份

创建备份策略