Querying Tags of a Specific Instance

Function

This API is used to query user tags of a specified instance. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/instances/{instance_id}/tags

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. For details about how to obtain the instance ID, see Querying DB Instances. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**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 used to obtain a user token. After a response is returned, the value of X-Subject-Token in the response header is the token. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn: Chinese en-us: English Default Value en-us

Response Parameters

**Table 3** Parameter description
Parameter	Type	Description
tags	Array of objects	Definition User tags. For details, see Table 4.
total_count	Integer	Definition Total number of records. Range N/A

**Table 4** tags field data structure description
Parameter	Type	Description
key	String	Definition Tag key. Range N/A
value	Array of strings	Definition Tag value.

Example Request

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/tags

Example Response

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