接口功能介绍
- 快照策略功能请联系客户经理开通。- 快照策略仅支持资源包来源的云电脑(即不支持单实例来源的云电脑)。- 如果云电脑已存在快照,且上一个快照时间点到执行周期时一直关机,则不自动创建快照,当用户开机后且到下一个执行周期,再创建快照。- 幂等接口,重复分配给同一个电脑会忽略并视为分配成功。- 注意!若云电脑已分配快照策略,原有快照策略会被取消。
接口约束
无
URI
POST /v3/snapshotPolicy/applyToDesktops
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID。 |
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
snapshotPolicyOid | 是 | String | 快照策略ID。 | ssp-gg7576hc59fkph1b3xe4y | |
desktopOidList | 是 | Array of Strings | 云电脑ID列表。长度限制[1,10]。 | D0023092201180710 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 状态码。可能值: - 800:请求成功。 - 900:请求失败。 |
800 | |
error | String | 错误码。 | ECPC_1000 | |
message | String | 提示信息。 | ok | |
returnObj | Object | 返回数据结构体。 | returnObj |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{"snapshotPolicyOid":"ssp-xxx","desktopOidList":["XXXXXXXXXXXXX6925"]}
响应示例
{"statusCode":800,"message":"OK.","returnObj":{ }}
状态码
请参考 状态码
错误码
请参考 错误码