Updated on 2024-11-04 GMT+08:00

Batch Deleting Resource Tags

Function

This API is used to delete tags from a specified instance in batches.

  • This API is idempotent, meaning that if the tag to be deleted does not exist, the deletion is successful.
  • A maximum of 20 tags can be deleted in a batch.
  • Character set validation is not performed when deleting tags.
  • The tags structure cannot be missing during deletion, and the key field cannot be empty or a null string.

URI

POST /v3/{project_id}/{resource_type}/{resource_id}/tags/delete

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

resource_type

Yes

String

Resource type. The options are:

  • dli_queue: queue
  • dli_elastic_resource_pool: elastic resource pool
  • dli_enhanced_datasource: enhanced datasource connection
  • dli_database: database
  • dli_package_resource: resource package (built-in resource packages with a module ID specified are not supported)
  • dli_flink_job: Flink job

resource_id

Yes

String

Resource ID.

Minimum length: 1 character

Maximum length: 1,000 characters

Obtain it as follows:
  • Queue ID: Obtain it by calling Querying All Queues. queue_id in the response indicates the queue ID.
  • Elastic resource pool ID: Obtain it by calling Querying All Elastic Resource Pools. resource_id in the response indicates the elastic resource pool ID.
  • Enhanced datasource connection ID: Obtain the Connection ID on the Enhanced tab of Data Connections page of the DLI management console.
  • Database ID: name of the database that is passed in when adding a tag. You can view the database name on the Data Management > Databases and Tables page of the DLI console.
  • Flink job ID: On the Job Management > Flink Jobs page of the DLI management console, click the name of a Flink job. On the displayed Flink job details page, obtain the Flink job ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

tags

Yes

Array of tags objects

Tag list. For details, see Table 3.

  • A maximum of 20 tags can be added.
  • Only one tag value can be added to a tag key.
  • Each key within a resource must be unique, and the values within the same key cannot be duplicated.
Table 3 tags

Parameter

Mandatory

Type

Description

key

Yes

String

Tag key.

A tag key can contain a maximum of 128 characters. Only letters, digits, spaces, and special characters (_.:+-@) are allowed, but the value cannot start or end with a space or start with _sys_.

value

Yes

String

Tag value.

A tag value can contain a maximum of 255 characters. Only letters, numbers, spaces, and special characters (_.:+-@) are allowed. The value cannot start or end with a space.

Response Parameters

None

Example Request

{
    "tags":[
        {
            "key":"key1"
        },
        {
            "key":"key2",
            "value":"value2"
        }
    ]
}

Example Response

None

Status Codes

Status Code

Description

204

The modification is successful.

400

Request error.

500

Internal server error.

Error Codes

See Error Codes.