接口功能介绍
- 并发桌面池功能请联系客户经理开通。- 当前仅支持操作Windows系统的政企版规格的并发桌面池
接口约束
无
URI
POST /v3/concurrentDesktopPool/changeImage
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 |
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| desktopPoolOid | 是 | String | 并发桌面池ID | dp-w8djg4dwv35w4c19o932g | |
| imageOid | 是 | String | 镜像ID，当前仅支持Windows系统、非GPU镜像 | mi-yr404205jf6br4f1dyb03 | |
| includeDataDisk | 否 | Boolean | 切换整机镜像时，是否包括数据盘，默认为否 | includeDataDisk |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ||
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回数据结构体。 | { } | returnObj |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{"desktopPoolOid":"dp-xxx","imageOid":"mi-xxx","includeDataDisk":null}
响应示例
{"statusCode":800,"message":"OK.","returnObj":{ }}
状态码
请参考 状态码
错误码
请参考 错误码
