文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 桌面/ sysprep版本信息检查 - CheckSysprepInfo
更新时间:2026-01-07 GMT+08:00

sysprep版本信息检查 - CheckSysprepInfo

功能介绍

检查sysprep版本信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    workspace:desktops:getSysPrepInfo

    Read

    desktop *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    -

URI

POST /v2/{project_id}/sysprep

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

desktop_ids

Array of strings

操作的桌面ID列表。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

sysprep_infos

Array of DesktopSysprepInfo objects

桌面Sysprep信息。

表4 DesktopSysprepInfo

参数

参数类型

描述

desktop_id

String

桌面id。

sysprep_version

String

sysprep版本。

support_hibernate

Boolean

是否支持休眠。

support_update_route

Boolean

是否支持修改路由。

状态码:401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

{
  "desktop_ids" : [ "f77db5cd-c020-47d4-bbbe-9b979a38d18c", "f77db5cd-c020-47d4-bbbe-9b979a38d18b" ]
}

响应示例

状态码:200

查询sysprep版本信息返回结果。

{
  "sysprep_infos" : [ {
    "desktop_id" : "string",
    "sysprep_version" : "string",
    "support_hibernate" : true,
    "support_update_route" : true
  } ]
}

状态码

状态码

描述

200

查询sysprep版本信息返回结果。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误,具体返回错误码请参见错误码说明。

错误码

请参见错误码