Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop Tag/ Adding Multiple Desktop Tags in Batches
Updated on 2026-02-10 GMT+08:00
View PDF
Share

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.

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:tag

    Tagging

    desktop *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    -

    -

    • g:RequestTag/<tag-key>

    • g:TagKeys

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 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 3 DesktopTagsInfo

Parameter

Mandatory

Type

Description

desktop_id

Yes

String

Desktop ID.

tags

Yes

Array of Tag objects

List of desktops containing tags.
Table 4 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 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

{
  "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