Help Center> Workspace> API Reference> Workspace APIs> Desktop Tag> Query Tags of a Specified Project
Updated on 2024-01-10 GMT+08:00
View PDF

Query Tags of a Specified Project

Function

Query all tags of a tenant.

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

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

Tag object.
Table 4 Tags

Parameter

Type

Description

key

String

Tag key.

values

Array of strings

Tag value.

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

/v2/{project_id}/desktops/tags

Example Responses

Status code: 200

Normal.

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

Status Codes

Status Code

Description

200

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