Adding or Deleting Secret Tags in Batches

Function

Add or delete secret tags in batches.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
secret_id	Yes	String	Secret ID

Request Parameter

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

**Table 3** Request body parameter
Parameter	Mandatory	Type	Description
tags	No	Array of TagItem objects	Tag list, which is the value pairs of key and value.
action	No	String	Operation. The value can be create or delete.
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	No	String	Key. The value can contain up to 36 Unicode characters. This parameter cannot be left empty or contain non-printable characters, including ASCII(0-31), *, <, >, \, and =.
value	No	String	Value. Each value can contain up to 43 Unicode characters and can be an empty string. It cannot contain non-printable characters, including ASCII(0-31), *, <, >, \, and =.

Response Parameters

Status code: 400

**Table 5** Response body parameter
Parameter	Type	Description
error	ErrorDetail object	-

**Table 6** ErrorDetail
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error information

Status code: 401

**Table 7** Response body parameter
Parameter	Type	Description
error	ErrorDetail object	-

**Table 8** ErrorDetail
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error information

Status code: 403

**Table 9** Response body parameter
Parameter	Type	Description
error	ErrorDetail object	-

**Table 10** ErrorDetail
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error information

Status code: 404

**Table 11** Response body parameter
Parameter	Type	Description
error	ErrorDetail object	-

**Table 12** ErrorDetail
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error information

Status code: 500

**Table 13** Response body parameter
Parameter	Type	Description
error	ErrorDetail object	-

**Table 14** ErrorDetail
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error information

Status code: 502

**Table 15** Response body parameter
Parameter	Type	Description
error	ErrorDetail object	-

**Table 16** ErrorDetail
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error information

Status code: 504

**Table 17** Response body parameter
Parameter	Type	Description
error	ErrorDetail object	-

**Table 18** ErrorDetail
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error information

Example Request

Add multiple secret tags. For tag 1, the key is key1 and the value is value1. For tag 2, the key is key2 and the value is value2.

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

Example Response

None

Status Code

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 requested 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.