Create Desktop Tags

Function

Creates tags for desktops. A desktop can have a maximum of 10 tags. If a to-be-created tag has the same key as an existing tag, the tag will be created and overwrite the existing one.

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

**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
tag	Yes	Tag object	Tag.

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

/v2/9c53a566cb3443ab910cf0daebca90c4/desktops/8e07d3e9-454e-4fc9-ba56-c631d05c4712/tags

{
  "tag" : {
    "key" : "ENV",
    "value" : "DEV"
  }
}

Example Responses

Status code: 204

Response to the request for creating a desktop tag.

""

Status Codes

Status Code	Description
204	Response to the request for creating a desktop tag.
400	Invalid parameter.
401	Authentication failed.
403	You do not have required permissions.
404	Resource not found.
500	Internal error.