Help Center/ Dedicated Host/ API Reference/ API/ DeH Tag Management/ Adding Tags to a DeH in Batches

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

View PDF

Adding Tags to a DeH in Batches

Function

This API is used to add tags to a specified DeH in batches.

Tag Management Service (TMS) uses this API to batch add tags to a DeH.

Constraint

A DeH allows a maximum of 10 tags.
This API is idempotent.
During tag creation, if a tag exists (both the key and value are the same as those of an existing tag), the tag is successfully processed by default.
A new tag will overwrite the original one if their keys are the same and values are different.

URI

POST /v1.0/{project_id}/dedicated-host-tags/{dedicated_host_id}/tags/action

Table 1 describes the parameters.

**Table 1** Parameters description
Parameter	Type	Mandatory	Description
project_id	String	Yes	Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
dedicated_host_id	String	Yes	Specifies the DeH ID. You can obtain the value from the DeH console or using the API in Querying DeHs.

Request

**Table 2** Request parameters
Parameter	Type	Mandatory	Description
tags	Array of objects	Yes	Specifies the tag list. For details, see Table 3.
action	String	Yes	Specifies the operation. Only lowercase letters are supported. For example, create indicates the creation operation.

**Table 3** **tag** field description
Parameter	Type	Mandatory	Description
key	String	Yes	Specifies the tag key. It contains a maximum of 36 Unicode characters. The value cannot be empty. It cannot contain the following ASCII characters: =*<>\\|/,
value	String	Yes	Specifies the tag value. It contains a maximum of 43 Unicode characters. It cannot contain the following ASCII characters: =*<>\\|/,

Response

N/A

Example Request

Add two tags to a DeH in a batch. The keys and corresponding values for these two tags are as follows: key1 and value1; key2 and value2.

POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/74259164-e63a-4ad9-9c77-a1bd2c9aa187/tags/action
{
    "action": "create",
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        },
        {
            "key": "key2",
            "value": "value2"
        }
    ]
}