Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop Tag/ Adding Multiple Desktop Tags in Batches

Updated on 2025-07-14 GMT+08:00

View PDF

Adding Multiple Desktop Tags in Batches

Function

Tags can be added to multiple desktops in batches. If the tags to be created already exist (with the same key), the tags will be overwritten by default. The operation can be performed on a maximum of 100 desktops, and a maximum of 20 tags are allowed for each desktop.

Debugging

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

URI

POST /v2/{project_id}/desktops/batch-tags

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

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).
Content-Type	No	String	MIME type of the request body.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
desktops	Yes	Array of DesktopTagsInfo objects	List of desktops (containing tags). Invalid desktop IDs are filtered out during batch operations.

**Table 4** DesktopTagsInfo
Parameter	Mandatory	Type	Description
desktop_id	Yes	String	Desktop ID.
tags	Yes	Array of Tag objects	List of desktops containing tags.

**Table 5** Tag
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the tag key. This parameter cannot be left blank and can contain a maximum of 128 Unicode characters. The value can contain uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). The value cannot contain the following characters: =*<>,\|/.
value	No	String	Value of a tag, which can contain a maximum of 43 Unicode characters. The value can contain uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). The value cannot contain the following characters: =*<>,\|/.

Response Parameters

Status code: 204

Normal.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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

{
  "desktops" : [ {
    "desktop_id" : "string",
    "tags" : [ {
      "key" : "string",
      "value" : ""
    } ]
  } ]
}

Example Responses

None

Status Codes

Status Code	Description
204	Normal.
400	Invalid parameter.
401	Authentication failed.
403	You do not have required permissions.
404	Resource not found.
500	Internal error.

Error Codes

See Error Codes.

Parent topic: Desktop Tag

Previous topic: Filtering Out Desktops by Tag

Next topic: Deleting Multiple Desktop Tags in Batches

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot