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

Querying Project Tags

Function

This API is used to query all secret tags of a user in a specified project.

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::listProjectTags

    List

    -

    -

    csms:tag:getAll

    -

URI

GET /v1/{project_id}/csms/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

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 TagResponse 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

Table 4 TagResponse

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

values

Array of strings

Definition

Tag value set.

There can be at most 10 tag values. Tag values in the tag list must be unique. If the value list is empty, any tag value is matched. When there are multiple values in the tag list and the key requirements are met, a value in the request is matched.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "tags" : [ {
    "key" : "key1",
    "values" : [ "val1" ]
  }, {
    "key" : "key2",
    "values" : [ "val2" ]
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.