查询虚拟机策略v3
更新时间 2026-11-09 15:06:18
最近更新时间: 2026-11-09 15:06:18
接口功能介绍
查询云电脑重启还原、计算机别名修改和桌面悬浮球配置。
接口约束
无
URI
GET /v3/strategy/virtualMachine/describe
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| strategyOid | 是 | String | 策略Oid。 | dsy-xxxxxx |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码，800表示请求成功，900表示请求失败。 | 800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 虚拟机策略详情。 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| strategyOid | String | 策略Oid。 | ||
| rebuildAfterReboot | Object | 云电脑关机或重启时的系统还原配置。 | rebuildAfterReboot | |
| computerAliasModificationEnable | Boolean | 是否允许用户修改云电脑别名。 | ||
| floatingBallEnable | Boolean | 是否启用AI悬浮球。 |
表 rebuildAfterReboot
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| mode | String | 关机或重启时的系统还原模式。 取值： - DISABLED：关闭。 - TEMPLATE：还原至模板。 - LATEST_SNAPSHOT： 还原至最近快照。 | ||
| templateScope | String | 模板还原范围。取值： - SYSTEM_DISK：仅系统盘。 - SYSTEM_AND_EMPTY_DATA_DISKS： 系统盘和空数据盘。 SYSTEM_AND_ALL_DATA_DISKS 系统盘和所有数据盘。 仅TEMPLATE模式返回。 其他模式为null。 |
枚举参数
无
请求示例
请求url
https://{host}?regionId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&strategyOid=dsy-xxxxxx
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"strategyOid":"dsy-xxxxxx",
"rebuildAfterReboot":{
"mode":"TEMPLATE",
"templateScope":"SYSTEM_DISK"
},
"computerAliasModificationEnable":true,
"floatingBallEnable":true
}
}
状态码
请参考 状态码
错误码
请参考 错误码
