创建云主机备份策略
接口功能介绍
创建云主机备份策略
准备工作 :
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
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.云主机备份策略有配额限制,请在配额限制范围内创建
URI
POST /v4/ecs/backup-policy/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取:查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
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 | |
projectID | 否 | String | 企业项目ID,企业项目管理服务提供统一的云资源按企业项目管理,以及企业项目内的资源管理,成员管理。 | 0 |
响应参数
参数 | 类型 | 描述 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | 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时返回 | 5 | |
regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
cycleType | String | 备份周期类型 | day | |
cycleDay | Integer | cycleType为day时返回备份周期值 | 8 | |
cycleWeek | String | cycleType为week时返回备份周期值 | 4 | |
policyID | String | 备份策略ID | 03b2d47aa3ae11eda7ae0242ac110009 | |
time | String | 备份整点时间 | 3 | |
projectID | String | 企业项目ID | 0 |
请求示例
请求头header
无
请求体body
示例:创建一个云主机备份策略,备份周期为5天,12点整时进行备份,备份的保留类型为按数量保存,保留5份,备份策略状态为启用。
{
"regionID":"bb9fdb42056f11eda1610242ac110002",
"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": 5,
"cycleType": "day",
"policyID": "e58e56ea7d4111ee8a540242ac110002",
"policyName": "backup-01",
"retentionType": "num",
"time": "12"
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数错误 |
EcsBackup.UserVisibleRegions.AccessFailed | 查询用户可见资源池失败 |
EcsBackup.RegionInfo.AccessFailed | 查询资源池失败 |
EcsBackup.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
EcsBackup.OrderCheck.InvalidProjectID | 企业项目不存在 |
EcsBackup.PolicyCheck.OverQuota | 用户云主机备份策略超出限额 |
EcsBackup.PolicyCheck.NameNotValid | policyName命名不合法 |
EcsBackup.PolicyCheck.PolicyNameExist | 云主机备份策略名称已存在 |
EcsBackup.PolicyCheck.TimeNotValid | time元素范围0-23 |
EcsBackup.PolicyCheck.StatusNotValid | status仅支持0/1 |
EcsBackup.PolicyCheck.RetentionTypeRequired | retentionType未指定 |
EcsBackup.PolicyCheck.RetentionTypeNotValid | retentionType只支持num/date/all |
EcsBackup.PolicyCheck.RetentionDayNotValid | retentionDay无效 |
EcsBackup.PolicyCheck.RetentionNumNotValid | retentionNum无效 |
EcsBackup.PolicyCheck.CycleTypeRequired | cycleType未指定 |
EcsBackup.PolicyCheck.CycleTypeNotValid | cycleType只支持day或者week |
EcsBackup.PolicyCheck.CycleWeekNotValid | cycleWeek参数无效 |
EcsBackup.PolicyCheck.CycleDayNotValid | cycleDay参数无效 |
EcsBackup.Admin.AccessFailed | 系统错误 |