doc-exports/docs/geminidb/api-ref/topic_300000015.html

Querying Tags of a Specified Project

Function

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

URI

GET https://{Endpoint}/v3/{project_id}/tags

Table 1 URI parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Table 2 Query parameters

Parameter	Mandatory	Type	Description
offset	No	Integer	Index offset. The query starts from the next piece of data indexed by this parameter. The value is 0 by default. The value must be a non-negative number.
limit	No	Integer	Maximum records to be queried. The value ranges from 1 to 100. If this parameter is not transferred, the first 100 records are queried by default.

Request Parameters

Table 3 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter	Type	Description
tags	Array of Tag objects	All tags.
total_count	Integer	Total number of records.

Table 5 Tag

Parameter	Type	Description
type	String	Tag type. The value can be: user system
key	String	Tag key. The tag key must be specified and can include a maximum of 36 Unicode characters. The key is case-sensitive and can contain digits, uppercase letters, lowercase letters, underscores (_), and hyphens (-).
values	Array of strings	Tag values. The value can include a maximum of 43 Unicode characters and can also be an empty string. The value is case-sensitive and can contain digits, uppercase letters, lowercase letters, underscores (_), periods (.), and hyphens (-).

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

See Status Codes.

Error Codes

See Error Codes.

Parent topic: Tags