Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop Tag/ Querying Desktop Tags
Updated on 2025-07-14 GMT+08:00
View PDF
Share

Querying Desktop Tags

Function

Queries the tag information of a specified desktop.

Debugging

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

URI

GET /v2/{project_id}/desktops/{desktop_id}/tags

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

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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tags

Array of Tag objects

Tag.
Table 4 Tag

Parameter

Type

Description

key

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

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: =*<>,|/.

Status code: default

Table 5 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

/v2/{project_id}/desktops/{desktop_id}/tags

Example Responses

Status code: 200

Queries desktop tags.

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

Status Codes

Status Code

Description

200

Queries desktop tags.

default

Abnormal response.

Error Codes

See Error Codes.

Parent topic: Desktop Tag