接口功能介绍
- 快照策略功能请联系客户经理开通。- 幂等接口,重复取消会忽略并视为取消成功。- 注意!若云电脑与快照策略不存在分配关系,取消时会直接忽略。
接口约束
无
URI
POST /v3/snapshotPolicy/cancelFromDesktops
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 |
请求参数
请求头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":{ }}
状态码
请参考 状态码
错误码
请参考 错误码