Updated on 2025-08-28 GMT+08:00

Adding or Deleting Secret Tags in Batches

Function

This API is used to add or delete secret tags in batches.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

secret_id

Yes

String

Secret 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 a token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tags

Yes

Array of TagItem objects

List of tags, including tag keys and tag values.

action

Yes

String

Operation type. It can be:

create or delete

sequence

No

String

36-byte sequence number of a request message.

Example: 919c82d4-8046-4722-9094-35c3c6524cff.

Table 4 TagItem

Parameter

Mandatory

Type

Description

key

Yes

String

Tag name

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.

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

value

No

String

Tag value.

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

Response Parameters

Status code: 204

No Content

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error

ErrorDetail object

Error message

Table 6 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned for an error request.

error_msg

String

Error information returned for an error request.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error

ErrorDetail object

Error message

Table 8 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned for an error request.

error_msg

String

Error information returned for an error request.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error

ErrorDetail object

Error message

Table 10 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned for an error request.

error_msg

String

Error information returned for an error request.

Status code: 404

Table 11 Response body parameters

Parameter

Type

Description

error

ErrorDetail object

Error message

Table 12 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned for an error request.

error_msg

String

Error information returned for an error request.

Status code: 500

Table 13 Response body parameters

Parameter

Type

Description

error

ErrorDetail object

Error message

Table 14 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned for an error request.

error_msg

String

Error information returned for an error request.

Status code: 502

Table 15 Response body parameters

Parameter

Type

Description

error

ErrorDetail object

Error message

Table 16 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned for an error request.

error_msg

String

Error information returned for an error request.

Status code: 504

Table 17 Response body parameters

Parameter

Type

Description

error

ErrorDetail object

Error message

Table 18 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned for an error request.

error_msg

String

Error information returned for an error request.

Example Requests

This API is used to add secret tags in batches.

{
  "action" : "create",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

204

No Content

400

Invalid request parameter.

401

A username and password are required.

403

Authentication failed.

404

The requested resource does not exist or is not found.

500

Internal service error.

502

The request failed to be fulfilled because the server received an invalid response from the upstream server.

504

Gateway timed out.

Error Codes

See Error Codes.