Updated on 2024-01-10 GMT+08:00

Query Desktop Tags

Function

Query 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

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.

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

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.

Example Requests

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

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

Example Responses

Status code: 200

Query desktop tags.

""

Status Codes

Status Code

Description

200

Query desktop tags.

default

Abnormal response.

Error Codes

See Error Codes.