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

Delete Desktop Tags

Function

Deletes a desktop tag. 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

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

desktop_id

Yes

String

Desktop ID.

key

Yes

String

Tag key.

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

Table 3 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 4 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 5 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 6 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 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 204

Response to the request for deleting a desktop tag.

""

Status Codes

Status Code

Description

204

Response to the request for deleting a desktop tag.

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.