接口功能介绍
该接口提供用户创建云主机快照策略的功能，快照策略可以通过设置相关参数，定时进行快照任务。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
用户配额：创建快照策略时需要注意配额，确认个人在不同资源池下资源配额，可以通过用户配额查询接口进行查询
接口约束
1. 快照策略名称（snapshotPolicyName）不可重复
2. 超过用户配额无法再创建快照策略
URI
POST /v4/ecs/snapshot-policy/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
81f7728662dd11ec810800155d307d5b | |
| snapshotPolicyName | 是 | String | 云主机快照策略名称，满足以下规则：长度为2~63字符，由数字、字母、-组成，只能以字母开头，以数字和字母结尾 | api-create01 | |
| snapshotTime | 否 | String | 快照整点时间，时间取值范围：0~23 注：如果一天内多个时间节点备份，以逗号隔开（如11点15点进行快照，则填写"11,15"），默认值0 |
12,13 | |
| cycleType | 是 | String | 云主机快照周期类型，取值范围： day（天）， week（周） |
day | |
| cycleDay | 否 | Integer | 快照周期（天），取值范围：[1, 10] 注：cycleType为day时需设置 |
1 | |
| cycleWeek | 否 | String | 快照周期（星期），星期取值范围：0~6（代表周几，其中0为周日） 注：只有cycleType为week时需设置； 如果一周有多天备份，以逗号隔开（如周日周三进行快照，则填写"0,3"） |
0,2,6 | |
| retentionType | 是 | String | 云主机快照保留类型，取值范围： date（按时间保存）， num（按数量保存） |
num | |
| retentionDay | 否 | Integer | 云主机快照保留天数，单位为天，取值范围：[1, 365] 注：retentionType为date时必填 |
2 | |
| retentionNum | 否 | Integer | 云主机快照保留数量，取值范围：[1, 30] 注：retentionType为num时必填 |
3 | |
| snapshotPolicyStatus | 否 | Integer | 快照策略状态，是否启用，取值范围：0（不启用）， 1（启用） 注：默认值1（启用） |
1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| snapshotPolicyStatus | Integer | 快照策略状态，是否启用，取值范围：0（不启用）， 1（启用） 注：默认值1（启用） |
1 | |
| snapshotPolicyName | String | 云主机快照策略名称，满足以下规则：长度为2~63字符，由数字、字母、-组成，只能以字母开头，以数字和字母结尾 | test-123 | |
| retentionType | String | 云主机快照保留类型，取值范围： date（按时间保存）， num（按数量保存） |
date | |
| retentionDay | String | 保留天数，当retentionType为date时返回，否则为空字符串 | 2 | |
| retentionNum | String | 保留数量，当retentionType为num时返回，否则为空字符串 | 2 | |
| cycleType | String | 备份周期类型，day-按天备份，week-按星期备份 | day | |
| cycleDay | Integer | 快照周期值，cycleType为day时返回 | 8 | |
| cycleWeek | String | 快照周期值，cycleType为week时返回，则取值范围0-6代表星期日-星期六，如果一周有多天备份，以逗号隔开 | 4 | |
| snapshotPolicyID | String | 云主机快照策略ID，32字节 获取： 查 查询云主机快照策略列表 创 创建云主机快照策略 |
03b2d47aa3ae11eda7ae0242ac110009 | |
| snapshotTime | String | 快照整点时间，时间取值范围：0~23 注：如果一天内多个时间节点备份，以逗号隔开（如11点15点进行快照，则填写"11,15"），默认值0 |
3 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例1：以天(day)为周期类型创建云主机快照策略，且快照保留类型为时间
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"snapshotPolicyName": "api-create01",
"cycleType": "day",
"cycleDay": 8,
"retentionType": "date",
"retentionDay": 30
}
示例2：以天(day)为周期类型创建云主机快照策略，且快照保留类型为数量
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"snapshotPolicyName": "api-create01",
"cycleType": "day",
"cycleDay": 8,
"retentionType": "num",
"retentionNum": 20
}
示例3：以周(week)为周期类型创建云主机快照策略，且快照保留类型为时间
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"snapshotPolicyName": "api-create01",
"cycleType": "week",
"cycleWeek": 1,
"retentionType": "date",
"retentionDay": 30
}
示例4：以周(week)为周期类型创建云主机快照策略，且快照保留类型为数量
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"snapshotPolicyName": "api-create01",
"cycleType": "week",
"cycleWeek": 1,
"retentionType": "num",
"retentionNum": 20
}
响应示例
{
"returnObj": {
"snapshotPolicyID": "2335ec0e05e911ee808c0242ac110005",
"retentionNum": "",
"snapshotTime": "12",
"snapshotPolicyStatus": 1,
"cycleType": "day",
"cycleDay": 10,
"retentionType": "date",
"retentionDay": 30,
"snapshotPolicyName": "api-create01",
"cycleWeek": ""
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
