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

Querying Tags of an Instance

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

This API supports the following instances:

A maximum of 20 tags can be added to a DB instance. The tag key must be unique.

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::listTagsForResource	List	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:instance:list nosql:tag:list	-

GET /v3/{project_id}/instances/{instance_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
instance_id	Yes	String	Definition Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one. Constraints N/A Range N/A Default Value N/A

**Table 2** 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

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
tags	Array of ListInstanceTagsResult objects	Definition Tags of the instance.

**Table 4** ListInstanceTagsResult
Parameter	Type	Description
key	String	Definition Tag key. The tag key can contain a maximum of 36 Unicode characters and must be specified. Range It is case-sensitive and can contain digits, letters, underscores (_), and hyphens (-).
value	String	Definition Tag value. The tag value can contain a maximum of 43 Unicode characters and can be an empty string. Range It is case-sensitive and can contain digits, letters, underscores (_), periods (.), and hyphens (-).

URI example

GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/tags

Status code: 200

Success

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

For details, see Status Codes.

For details, see Error Codes.

Parent topic: Tags