Querying Project Tags¶

Function¶

This API is used to query all tags of instances in a specified project. Before using this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI¶

GET /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. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.
limit	No	Integer	Number of records to be queried. The default value is 100. The value must be a positive integer. The minimum value is 1 and the maximum value is 100.

Request Parameters¶

**Table 3** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.
X-Language	No	String	Language.

Response Parameters¶

Status code: 200

**Table 4** Response body parameters¶
Parameter	Type	Description
total_count	Integer	Total number of records.
tags	Array of ProjectTagItem objects	Tag list.

**Table 5** ProjectTagItem¶
Parameter	Type	Description
key	String	Tag key.
values	Array of strings	Tag value.

Status code: 400

**Table 6** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request¶

Querying tags in a specified project

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/tags?offset=0&limit=2

Example Response¶

Status code: 200

Success.

{
  "total_count" : 2,
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  }, {
    "key" : "key2",
    "values" : [ "value3", "value4" ]
  } ]
}

Status Code¶

For details, see Status Codes.

Error Code¶

For details, see Error Codes.

last updated: 2024-05-20 01:10