doc-exports/docs/rds/api-ref/rds_01_0007.html
Wang , Deng Ke 5208dcae7b RDS API 20221104 version
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
2022-11-10 09:55:48 +00:00

9.2 KiB
Raw Permalink Blame History

Querying a Tag

Function

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

URI

  • URI format

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

    Method: GET

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    instanceId

    Yes

    Specifies the primary node ID of the DB instance.

  • Restrictions

    Standby DB instances do not support tag queries.

Request

None

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 (031) 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 (031) and the following special characters: *<>\=

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

Abnormal Response

For details, see Abnormal Request Results.