Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Verifying a Desktop Image

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

View PDF

Verifying a Desktop Image

Function

Checks whether the desktop image of a specified desktop exists. If the desktop image exists, the corresponding image ID is returned; otherwise, no image ID is returned.

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:images:checkIfExist	Write	-	-	-	ims:images:list

URI

POST /v2/{project_id}/desktops/check-images

**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
image_infos	Array of DesktopImageInfo objects	Desktop image information.

**Table 4** DesktopImageInfo
Parameter	Type	Description
desktop_id	String	Desktop ID.
image_id	String	Image ID.
image_name	String	Image name.
image_type	String	Image type.
os_type	String	Image system type.

Status code: 400

**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: 401

**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: 403

**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: 404

**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.

Status code: 500

**Table 9** 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 verifying a cloud desktop.

{
  "image_infos" : [ {
    "desktop_id" : "0730042a-b9c7-4279-bb24-d3fd299a2efe",
    "image_id" : "b669106a-1395-4f24-92af-d884c227e558",
    "image_type" : "market",
    "os_type" : "Windows"
  } ]
}

Status Codes

Status Code	Description
200	Response to the request for verifying a cloud desktop.
400	The request cannot be understood by the server due to malformed syntax.
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.