Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop Tag/ Deleting a Desktop Tag
Updated on 2026-02-10 GMT+08:00
View PDF
Share

Deleting a Desktop Tag

Function

Deletes a desktop tag. If the tag to be deleted does not exist, the deletion is considered successful.

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:desktops:untag

    Tagging

    desktop *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    -

    -

    • g:RequestTag/<tag-key>

    • g:TagKeys

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

None

Response Parameters

Status code: 204

Response to the request for deleting a desktop tag.

Status code: 400

Table 2 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

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.

Status code: 401

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

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.

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

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.

Status code: 404

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

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.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

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

None

Example Responses

None

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.

Parent topic: Desktop Tag