Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Tag Management/ Querying Tags of a Specific Instance
Updated on 2025-08-11 GMT+08:00

Querying Tags of a Specific Instance

Function

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

URI

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

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

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

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

None

Response Parameters

Table 2 Parameter description

Parameter

Type

Description

tags

Array of objects

Definition

User tags.

For details, see Table 3.

total_count

Integer

Definition

Total number of records.

Range

N/A

Table 3 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
}

Status Codes

Error Codes

For details, see Error Codes.