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

Querying Secret Tags

Function

This API is used to add a secret tag.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/csms/{secret_id}/tags

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

secret_id

Yes

String

Definition

Secret ID

Constraints

N/A

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. This parameter is optional if AK/SK authentication is used.

Constraints

N/A

Range

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

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tag

Yes

TagItem object

Tag information

Table 4 TagItem

Parameter

Mandatory

Type

Description

key

Yes

String

Definition

Tag name

Constraints

  • The tag keys of a secret cannot have duplicate values. A tag key can be used for multiple secrets.

  • A secret can have up to 20 tags.

Range

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

Default Value

N/A

value

No

String

Definition

Tag value

Constraints

N/A

Range

The value can contain at most 255 characters and must match the regular expression ^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$.

Default Value

N/A

Response Parameters

Status code: 204

No Content

None

Example Requests

This API is used to add a secret tag.

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

Example Responses

None

Status Codes

Status Code

Description

204

No Content

Error Codes

See Error Codes.