Updated on 2025-09-15 GMT+08:00

Adding Tags to a Key

Function

This API is used to add a key tag.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/kms/{key_id}/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

key_id

Yes

String

Key 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 used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tag

No

TagItem object

Tag.

sequence

No

String

A 36-byte serial number of a request message, for example, 919c82d4-8046-4722-9094-35c3c6524cff

Table 4 TagItem

Parameter

Mandatory

Type

Description

key

Yes

String

Key. The value can contain up to 36 unicodes. This parameter cannot be left empty. The following nonprintable characters cannot be included: ASCII(0-31), *, <, >, , and =.

value

No

String

Key. The value can contain up to 43 unicodes. This parameter can be left empty. The following nonprintable characters cannot be included: ASCII(0-31), *, <, >, , and =.

Response Parameters

Status code: 204

No Content

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 6 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 8 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 10 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 404

Table 11 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 12 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 500

Table 13 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 14 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 502

Table 15 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 16 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 504

Table 17 Response body parameters

Parameter

Type

Description

error

Object

Error message

Table 18 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Example Requests

Add a tag whose key is DEV and value is DEV1.

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

Example Responses

None

Status Codes

Status Code

Description

204

No Content

400

Invalid request parameters.

401

Username and password are required for the requested page.

403

Authentication failed.

404

The resource does not exist.

500

Internal service error.

502

Failed to complete the request. The server receives an invalid response from the upstream server.

504

Gateway timed out.

Error Codes

See Error Codes.