Updated on 2025-08-20 GMT+08:00

Querying Tags of a DB Instance

Function

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

URI

  • URI format

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

  • Parameter description
    Table 1 Parameters

    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

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

  • Request parameters

    None

  • URI example

    GET https://rds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/ab67f50938cb4d189cc2163ca0098fe7in03/tags

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    tags

    Array of objects

    Definition

    Tag list. If there is no tag added for the instance, an empty array is returned.

    For details, see Table 3.

    Table 3 tags field data structure description

    Parameter

    Type

    Description

    key

    String

    Definition

    Tag key.

    Range

    N/A

    value

    String

    Definition

    Tag value.

    Range

    N/A

    tag_type

    String

    Definition

    Tag type.

    Range

    Enumerated values: user and system

  • Example normal response
    {
         "tags": [{
            "key": "keyName",
            "value": "keyValue",
            "tag_type": "user"
            }]
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.