Deleting Tags from an ECS in a Batch
Function
- This API is used to delete tags from a specified ECS in a batch.
- The Tag Management Service (TMS) uses this API to batch manage the tags of an ECS.
- This API is idempotent. When you delete a tag but the tag does not exist, a successful result is returned by default.
Constraints
An ECS can have a maximum of 20 tags.
URI
POST /v1/{project_id}/cloudservers/{server_id}/tags/action
| Parameter | Mandatory | Description |
|---|---|---|
| project_id | Yes | Definition Specifies the project ID. For details about how to obtain the ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
| server_id | Yes | Definition Specifies the ECS ID. Constraints N/A Range N/A Default Value N/A |
Request
Table 2 describes the request parameters.
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| tags | Yes | Array of objects | Definition Specifies tags. For details, see Table 3. Constraints A maximum of 20 tags are allowed. They cannot start with _sys_. Range N/A Default Value N/A |
| action | Yes | String | Definition Specifies the operation identifier. Constraints Only lowercase letters are supported. Range delete Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| key | Yes | String | Definition Specifies the tag key. Constraints
Range
Default Value N/A |
| value | No | String | Definition Specifies the tag value. This field can be left blank. Constraints N/A Range
Default Value N/A |
Response
None
Example Request
Batch delete two pairs of tags from a specified ECS.
POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/tags/action
{
"action": "delete",
"tags": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value3"
}
]
} Example Response
None
Returned Values
Error Codes
See Error Codes.