Updated on 2026-01-08 GMT+08:00

Querying Resource Tags

Description

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

Restrictions

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

URI

  • URI format

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

Table 1 Path parameters

Name

Type

IN

Mandatory

Description

project_id

string

path

Yes

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

instance_id

string

path

Yes

Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token

Response Parameters

Table 3 Parameter description

Parameter

Mandatory

Type

Description

tags

Yes

Array of objects

The tag list. For more information, see Table 4.

Table 4 tags field data structure description

Parameter

Mandatory

Type

Description

key

Yes

String

The tag key.

  • The key cannot be empty and contains 1 to 128 single-byte characters.
  • The value can contain UTF-8 letters, digits, spaces, and the following characters: _.:/=+-@
  • Do not enter labels starting with _sys_, which are system labels.

Character set: 0-9, A-Z, a-z, "_", and "-".

value

Yes

String

The tag value.

  • The value can contain UTF-8 letters, digits, spaces, and the following characters: _.:/=+-@
  • The value can be empty or null and contains 0 to 255 single-byte characters.

Character set: 0-9, A-Z, a-z, "_", ".", and "-".

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

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.