• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. API v1
  5. Tag Management
  6. Querying a Tag

Querying a Tag

Function

This API is used to query the tag associated with a DB instance.

URI

  • URI format

    PATH: /{versionId}/{project_id}/rds/{instanceId}/tags

    Method: GET

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    versionId

    Yes

    Specifies the API version. It is case-sensitive and the value is v1.

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    instanceId

    Yes

    Specifies the ID of the DB instance associated with the tag to be queried.

  • Restrictions

    Standby DB instances do not support tag queries.

Request

N/A

Normal Response

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Description

    tags

    List data structure. For details, see Table 3.

    Specifies the tag information.

    Table 3 tags field data structure description

    Name

    Type

    Description

    key

    String

    Specifies the tag key.

    Its value cannot be empty and must be 1 to 36 Unicode characters in length. It cannot contain nonprintable ASCII characters (0–31) and the following special characters: *<>\=

    value

    String

    Specifies the tag value.

    Its value can be empty or 1 to 43 Unicode characters in length. It cannot contain nonprintable ASCII characters (0–31) and the following special characters: *<>\=

  • Response example
    {
           "tags": [
            {
                "key": "key1",
                "value": "value1"
            },
            {
                "key": "key2",
                "value": "value3"
            }
        ]
    }

Abnormal Response

For details, see Abnormal Request Results.