查询桌面制作自定义镜像检测结果v3
更新时间 2026-08-10 19:35:18
最近更新时间: 2026-08-10 19:35:18
接口功能介绍
- 请将云电脑中的敏感数据删除之后再检测,避免数据安全隐患。- 请勿在检测过程中对所选云电脑及其相关资源进行其他操作。- 自定义镜像检测会花费10分钟左右。
接口约束
无
URI
POST /v3/customImage/getCheckResult
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| desktopOid | 是 | String | 云电脑OID |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值: - 800:请求成功。 - 900:请求失败。 | 800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回数据结构体。 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| agentCallBackCode | Integer | 不同的值表示不同的检测进度,0表示发起检测成功,其他表示失败,具体如下:-7,表示桌面检测过程中在线运行;-6,表示未知错误;-5,表示第一次接收检测结果超时;-4,表示桌面开机失败;-3,表示桌面开机中;其他表示检测超时未收到检测结果; | ||
| errorMsg | String | 错误信息 | ||
| mirrorCheckRemark | String | 最终是否检测成功的唯一判断标识,检测结果,success表示通过,failure表示失败 | ||
| schedule | Integer | 检测进度,百分比数,例如:60,表示检测60% | ||
| mirrorCheckResult | Array of Objects | 每项检测详情 | mirrorCheckResult |
表 mirrorCheckResult
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 检测项标题 | ||
| mustCheck | Boolean | 是否必须检测项 | ||
| result | Integer | 检测结果,0表示检测不通过,1表示检测通过,2-检测中,3-检测超时 | ||
| reason | String | 检测不通过的原因 | ||
| msg | String | 检测不通过的信息提示 | ||
| solution | String | 检测不通过时的解决方案 |
枚举参数
无
请求示例
请求url
https://{host}?regionId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&desktopOid=xxx
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"agentCallBackCode":0,
"mirrorCheckRemark":"success",
"schedule":100,
"mirrorCheckResult":[{
"name":"系统盘检测",
"mustCheck":true,
"result":1,
"reason":"",
"msg":"",
"solution":""
},{
"name":"数据盘检测",
"mustCheck":false,
"result":1,
"reason":"",
"msg":"",
"solution":""
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码