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

Querying Tags of a Specified Project

Function

This API is used to query tags of a specified project.

Authorization Information

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

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
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

gaussdbfornosql:tag:list

List

-

-

nosql:tag:list

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:tag:list	List	-	-	nosql:tag:list	-

URI

GET /v3/{project_id}/tags

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints The value cannot be negative. Range N/A Default Value 0
limit	No	Integer	Definition Maximum records to be queried. Constraints N/A Range 1–100 Default Value 100

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
tags	Array of Tag objects	Definition Tags. For details, see Tag.
total_count	Integer	Definition Total number of records. Range N/A

**Table 5** Tag
Parameter	Type	Description
type	String	Definition Tag type. Range user: user-defined tag system: system tag
key	String	Definition Tag key. Range Each tag key can contain up to 36 Unicode characters and cannot be left blank. Only digits, uppercase letters, lowercase letters, underscores (_), and hyphens (-) are allowed.
values	Array of strings	Definition Tag values. Each tag value can contain a maximum of 43 Unicode characters and can be an empty string. Only digits, uppercase letters, lowercase letters, underscores (_), periods (.), and hyphens (-) are allowed.

Example Requests

URI example

GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/tags?offset=1&limit=10

Example Responses

Status code: 200

Success

{ 
  "tags" : [ { 
    "key" : "key1", 
    "values" : [ "value1", "value2" ], 
    "type" : "user" 
  }, { 
    "key" : "key2", 
    "values" : [ "value1", "value2" ], 
    "type" : "system" 
  } ], 
  "total_count" : 2 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Tags