Updated on 2026-06-11 GMT+08:00

Querying Secret Tags

Function

This API is used to query secret tags.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    csms:secret:listTags

    List

    secretName *

    • csms:Type

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    csms:tag:getBySecret

    -

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

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

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

Table 5 SysTag

Parameter

Type

Description

key

String

Definition

Tag key

Constraints

N/A

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

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

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

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

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.