Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Checking the Sysprep Version

Updated on 2026-02-10 GMT+08:00

View PDF

Checking the Sysprep Version

Function

Checks the Sysprep version.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:desktops:getSysPrepInfo	Read	desktop *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-	-

URI

POST /v2/{project_id}/sysprep

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
desktop_ids	No	Array of strings	IDs of desktops on which operations are performed.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
sysprep_infos	Array of DesktopSysprepInfo objects	Desktop Sysprep information.

**Table 4** DesktopSysprepInfo
Parameter	Type	Description
desktop_id	String	Desktop ID.
sysprep_version	String	Sysprep version.
support_hibernate	Boolean	Whether hibernation is supported.
support_update_route	Boolean	Whether routes can be modified.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

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

Example Responses

Status code: 200

Response to the request for querying the Sysprep version.

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

Status Codes

Status Code	Description
200	Response to the request for querying the Sysprep version.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
500	An internal service error occurred. For details about the error code, see the error code description.