Updated on 2022-12-07 GMT+08:00

Querying Resource Tags

Function

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

Constraints

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

URI

  • URI format

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

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    instance_id

    Yes

    Specifies the DB instance ID.

Requests

  • Request header
    GET https://DDS endpoint/v3/{project_id}/instances/{instance_id}/tags
  • Request body

    N/A

Responses

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    tags

    Yes

    Array of objects

    Indicates the tag list. For more information, see Table 3.

    Table 3 tags field data structure description

    Name

    Mandatory

    Type

    Description

    key

    Yes

    String

    Indicates 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

    Indicates 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.