• Data Warehouse Service

dws
  1. Help Center
  2. Data Warehouse Service
  3. API Reference
  4. API Description
  5. Tag Management APIs
  6. Adding or Deleting Resource Tags in Batches

Adding or Deleting Resource Tags in Batches

Function

This API is used to add or delete tags in batches for a specified resource. A maximum of 10 tags can be added for one resource.

URI

  • URI format

    POST /v1.0/{project_id}/clusters/{resource_id}/tags/action

  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

    resource_id

    Yes

    String

    Resource ID. Example: 7d85f602-a948-4a30-afd4-e84f47471c15

Request

  • Sample request for adding tags in batches
    POST /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/7d85f602-a948-4a30-afd4-e84f47471c15/tags/action
    {
        "action": "create",
        "tags": [
            {
                "key": "Flower",
                "value": "rose"
            },
            {
                "key": "Food",
                "value": "pie"
            }
        ]
    }
  • Sample request for deleting tags in batches
    POST /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/7d85f602-a948-4a30-afd4-e84f47471c15/tags/action
    {
        "action": "delete",
        "tags": [
            {
                "key": "Flower",
                "value": "rose"
             },
            {
                "key": "Food",
                "value": "pie"
            }
        ]
    }
  • Parameter description
    Table 2 Request parameter description

    Parameter

    Mandatory

    Type

    Description

    tags

    Yes

    List<resource_tag>

    Tag list. For details, see Table 3.

    action

    Yes

    String

    Identifies the operation. The value can be create or delete.

    • create: indicates to add tags in batches.
    • delete: indicates to delete tags in batches.
    Table 3 resource_tag field description

    Parameter

    Mandatory

    Type

    Description

    key

    Yes

    String

    Tag key. A tag key can contain a maximum of 36 Unicode characters, which cannot be null. The first and last characters cannot be spaces.

    It can contain only uppercase letters (A to Z), lowercase letters (a to z), digits (0-9), hyphens (-), and underscores (_).

    value

    Yes

    String

    Key value. A tag value can contain a maximum of 43 Unicode characters, which can be null. The first and last characters cannot be spaces.

    It can contain only uppercase letters (A to Z), lowercase letters (a to z), digits (0-9), hyphens (-), and underscores (_).

Response

Sample response

STATUS CODE 204

Returned Value

  • Normal

    204

  • Abnormal
    Table 4 Returned value for failed requests

    Returned Value

    Description

    400

    Invalid tag.

    401

    Authentication failed.

    403

    You do not have the rights to perform the operation.

    404

    The requested resource was not found.

    500

    Internal service error.