Updated on 2024-12-03 GMT+08:00

Adding Resource Tags

Function

Add tags to a specified resource.

The API is idempotent.

If a to-be-created tag has the same key as an existing tag, the tag will be created and overwrite the existing one.

URI

POST /v2/{project_id}/{resource_type}/{resource_id}/tags

For details, see Table 1.
Table 1 Parameters in the URI

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. You can obtain it in Obtaining a Project ID.

resource_type

Yes

String

Resource type.

  • DNS-private_zone
  • DNS-private_recordset

resource_id

Yes

String

Resource ID

Request

  • Parameter description
    Table 2 Parameter in the request

    Parameter

    Mandatory

    Type

    Description

    tag

    Yes

    Object

    Tag

    For details, see Table 3.

    Table 3 Parameters in the tag list

    Parameter

    Mandatory

    Type

    Description

    key

    Yes

    String

    Tag key

    A key can contain up to 36 Unicode characters. The key cannot be empty.

    value

    No

    String

    Tag value

    Each value can contain up to 43 Unicode characters and can be an empty string.

  • Example request
    Add tags for the private zone whose ID is ff8080825b8fc86c015b94bc6f8712c3:
    POST https://{DNS_Endpoint}/v2/{project_id}/DNS-private_zone/ff8080825b8fc86c015b94bc6f8712c3/tags
    {
        "tag": {
            "key": "key1", 
            "value": "value1"
        }
    }

Response

None

Returned Value

If a 2xx status code is returned, for example, 200, 202, or 204, the request is successful.

For details, see Status Code.