Updated on 2026-09-21 GMT+08:00

Deleting Key Tags

Function

This API is used to delete a key tag.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1.0/{project_id}/kms/{key_id}/tags/{key}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

The value returned by the IAM API is used, which contains 32 characters.

Default Value

N/A

key_id

Yes

String

Definition

Key ID

Constraints

  • The value must be a 36-byte ID.

  • The value must match the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$.

Range

N/A

Default Value

N/A

key

Yes

String

Definition

Tag key

Constraints

  • The value must contain 1 to 255 bytes.

  • The value must match the regular expression ^((?!\s)(?!sys)[\p{L}\p{Z}\p{N}_.:=+-@]*)(?<!\s)$.

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

Obtain the value by calling the IAM API for obtaining the user token.

Default Value

N/A

Response Parameters

Status code: 204

No Content

None

Example Requests

In the 0d0466b0e7274d9cb35df84bb474a37f project, delete the tag whose key value is testKey from the bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e key.

DELETE /v1.0/0d0466b0e7274d9cb35df84bb474a37f/kms/bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e/tags/testKey

Example Responses

None

Status Codes

Status Code

Description

204

No Content

Error Codes

See Error Codes.