Help Center> Workspace> API Reference> Workspace APIs> Desktop Tag> Add or Delete Tags in Batches
Updated on 2024-01-10 GMT+08:00
View PDF

Add or Delete Tags in Batches

Function

Add or delete tags in batches for a specified desktop. If a to-be-created tag has the same key as an existing tag, the tag will be created and overwrite the existing one. If the tag to be deleted does not exist, the deletion is successful by default.

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/{desktop_id}/tags/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

desktop_id

Yes

String

Desktop ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API, which is 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

action

No

String

Operation string create or delete.

tags

No

Array of Tag objects

Tag object.

sys_tags

No

Array of Tag objects

Tag object.
Table 4 Tag

Parameter

Mandatory

Type

Description

key

Yes

String

Specifies the key of a tag that cannot be empty 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: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error description.

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

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

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

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

Example Requests

{
  "action" : "create",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value3"
  } ]
}

Example Responses

Status code: 204

Normal.

""

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