Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Tags/ Querying Tags of an Instance
Updated on 2025-02-28 GMT+08:00
View PDF
Share

Querying Tags of an Instance

Function

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

Constraints

This API supports the following instance types:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx
  • GeminiDB Redis

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

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

instance_id

Yes

String

Explanation:

Instance ID

Constraints:

N/A

Values:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tags

Array of ListInstanceTagsResult objects

Explanation:

Tags of the instance.
Table 4 ListInstanceTagsResult

Parameter

Type

Description

key

String

Explanation:

Tag key. The tag key can contain a maximum of 36 Unicode characters and must be specified.

Values:

It is case-sensitive and can contain digits, letters, underscores (_), and hyphens (-).

value

String

Explanation:

Tag value. The tag value can contain a maximum of 43 Unicode characters and can be an empty string.

Values:

It is case-sensitive and can contain digits, letters, underscores (_), periods (.), and hyphens (-).

Example Request

URI example 
GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/tags

Example Response

Status code: 200

Success

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

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Tags