Querying Secret Tags

This API is used to query secret tags.

For details, see Calling APIs.

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
secret_id	Yes	String	Secret ID

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

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
tags	Array of TagItem objects	Tag list, which is the value pairs of tag keys and values. key: Tag key. A secret can contain up to 20 keys. This value cannot be left blank or repeated. The value of a key must be unique and can contain up to 128 characters. value: Tag value. Each tag value can contain up to 255 characters. A search result matches all the values.
sys_tags	Array of SysTag objects	System tags

**Table 4** TagItem
Parameter	Type	Description
key	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	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}_.:\/=+\-@]) $**.

**Table 5** SysTag
Parameter	Type	Description
key	String	The tag key.
value	String	Tag value

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 7** 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 8** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 9** 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 10** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 11** 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 12** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 13** 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 14** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 15** 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 16** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 17** 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 18** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 19** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

None

Status code: 200

Request succeeded.

{
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ],
  "sys_tags" : null
}

Status Code	Description
200	Request succeeded.
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.