Overview
You can call this API to delete a specified tag. In this API, the id parameter specifies the ID of the tag value (the id field in the tagValueList array). This parameter indicates the complete tag to be deleted.
API details
Constraints
The caller must have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
DELETE /api/v2/tags
Request parameters
Query
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| Action | String | Yes | The action to be performed. Fixed value: DeleteIamTag | DeleteIamTag |
Body
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| orgId | String | Yes | The ID of the organization. | ukp31txz9tmk6yqckhoxl356 |
| id | Integer | Yes | The ID of the tag value (the id field in the tagValueList array). This parameter indicates the complete tag to be deleted. | 244 |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| requestId | String | The ID of the request. | - |
| data | Object | The operation result. | - |
| success | Boolean | Indicates whether the operation succeeded. | true |
Examples
Request example
curl --digest -u 'ak:sk' \
-X DELETE \
'https://dev-api-cloud-cn.oceanbase.com/api/v2/tags?Action=DeleteIamTag' \
-H "Content-Type: application/json" \
-d '{
"orgId": "ukp31txz9tmk6yqckhoxl356",
"id": 244
}'
Response example
JSON format
{
"data": {},
"requestId": "",
"success": true
}