Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ Tag Management/ Querying Resource Tags
Updated on 2022-12-12 GMT+08:00
View PDF

Querying Resource Tags

Description

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

Restrictions

A maximum of 20 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

  • URI example

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/tags

Requests

Parameter description

Table 1 Request parameters

Name

Type

IN

Mandatory

Description

x-auth-token

string

header

Yes

User token

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.

Responses

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    tags

    Yes

    Array of objects

    The tag list. For more information, see Table 3.
    Table 3 tags field data structure description

    Name

    Mandatory

    Type

    Description

    key

    Yes

    String

    The tag key. The value contains 36 Unicode characters and cannot be blank.

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

    value

    Yes

    String

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

    Character set: 0-9, A-Z, a-z, "_", "." and "-".
  • Response example 
    {
  "tags": [
    {
      "key": "key1",
      "value": "value1"
    },
    {
      "key": "key2",
      "value": "value2"
    }
  ]
}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.

Parent topic: Tag Management