接口功能介绍
- 快照策略功能请联系客户经理开通。- 快照策略仅支持资源包来源的云电脑（即不支持单实例来源的云电脑）。- 如果云电脑已存在快照，且上一个快照时间点到执行周期时一直关机，则不自动创建快照，当用户开机后且到下一个执行周期，再创建快照。
接口约束
无
URI
POST /v3/snapshotPolicy/modify
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 |
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| snapshotPolicyOid | 是 | String | 快照策略ID。 | ssp-zf13as8ds7ccqb86z8s57 | |
| snapshotPolicyName | 是 | String | 快照策略名称。只能包含中文、数字、英文字母、下划线、中划线，长度限制1-64个字符。 | AS-116 | |
| snapshotType | 是 | String | 快照类型。枚举值范围：sys-系统盘;data-数据盘;all-系统盘和数据盘，其中data和all是数据盘相关的快照类型，请联系客户经理开通。 | sys | |
| snapshotTimePoints | 是 | Array of Strings | 快照时间点集合。使用UTC+8时间。任意2个时间差必须大于等于1小时。时间点数量范围[1,24]。时间点格式：HH:mm。 | ||
| cycleType | 是 | String | 快照的周期类型。枚举值范围：Week-按周;Day-按天。 | Day | |
| daysOfWeek | 否 | Array of Strings | 一个星期中需要快照的天。快照周期为按周时必填。取值范围[1,7]，数量限制[1,7]，不允许重复值。 | [2,7] | |
| cycleDayCnt | 否 | Integer | 快照周期天数。快照周期为按天时必填。取值范围[1,10000]。 | 3 | |
| retentionRule | 是 | String | 保留规则。枚举值范围：Month-按月;Day-按天;Quantity-按数量;Forever-永久保留。 | Day | |
| retentionMonthCnt | 否 | Integer | 保留月数。retentionRule为Month时必填。取值范围[1,12]。 | 2 | |
| retentionDayCnt | 否 | Integer | 保留天数。retentionRule为Day时必填。取值范围[1,99999]。 | 1 | |
| retentionCnt | 否 | Integer | 保留数量。retentionRule为Quantity时必填。取值范围[1,99999]。 | 4 | |
| autoDelete | 否 | Boolean | 是否自动删除。retentionRule为Quantity时需要填写，默认为true。 | autoDelete | |
| description | 是 | String | 描述。字符数限制[0,254]。 | 0 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | ok | |
| returnObj | Object | 返回数据结构体。 | returnObj |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{"snapshotPolicyOid":"ssp-xxx","snapshotPolicyName":"fooName","snapshotType":"sys","snapshotTimePoints":["00:00","01:00"],"cycleType":"Day","daysOfWeek":null,"cycleDayCnt":3,"retentionRule":"Day","retentionMonthCnt":null,"retentionDayCnt":4,"retentionCnt":null,"autoDelete":false,"description":""}
响应示例
{"statusCode":800,"message":"OK.","returnObj":{ }}
状态码
请参考 状态码
错误码
请参考 错误码
