• Relational Database Service

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

Adding a Tag

Function

This API is used to add a tag to a DB instance.

URI

  • URI format

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

    Method: POST

  • 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 for which the tag is to be added.

  • Restrictions
    • A tag can be added once at a time by calling this API. A maximum of 10 tags can be added to a DB instance. The tag key must be unique.
    • Standby DB instances do not support tag adding.

Request

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    tag

    Yes

    Dictionary data structure. For details, see Table 3.

    Specifies the tag information.

    Table 3 tag field data structure description

    Name

    Mandatory

    Type

    Description

    key

    Yes

    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

    Yes

    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: *<>\=

  • Request example
    {
         "tag":
            {
                "key": "ENV", 
                "value":"DEV"
            }    
    }

Normal Response

{}

Abnormal Response

For details, see Abnormal Request Results.