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

Querying Secret Tags

Function

This API is used to query secret tags.

Calling Method

For details, see Calling APIs.

URI

GET /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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tags

Array of TagItem objects

Definition

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. A key can contain at most 128 characters.

  • value: Tag value. Each tag value can contain up to 255 characters. A search result matches all the values.

Range

N/A

sys_tags

Array of SysTag objects

Definition

System tag list

Range

N/A

Table 4 TagItem

Parameter

Type

Description

key

String

Definition

Tag name

Range

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

Definition

Tag value

Range

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

Table 5 SysTag

Parameter

Type

Description

key

String

Definition

Tag key.

Range

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

Definition

Tag value.

Range

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

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

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

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.