Deleting Resource Tags in Batches¶

Function¶

This API is used to delete resource tags (stream tags) in batches. This API is idempotent. If the deleted tag does not exist, the deletion is considered successful by default. The tag character set range is not verified during tag deletion. When you delete tags, the tag structure cannot be missing, and the key cannot be left blank or be an empty string.

URI¶

POST /v2/{project_id}/stream/{stream_id}/tags/action

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
stream_id	Yes	String	Stream ID.

Request Parameters¶

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
action	Yes	String	Operation to be performed. The value can only be delete, which indicates batch deletion. Enumeration values: delete
tags	Yes	Array of Tag objects	Tag list.

**Table 4** Tag¶
Parameter	Mandatory	Type	Description
key	No	String	Key It cannot be left blank. It must be unique for each resource. It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF). Minimum: 1 Maximum: 36
value	No	String	Value It can contain a maximum of 43 characters. It can contain uppercase and lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF). It can only contain digits, letters, hyphens (-), and underscores (_). Minimum: 0 Maximum: 43

Response Parameters¶

None

Example Requests¶

Deleting Resource Tags in Batches

POST https://{Endpoint}/v2/{project_id}/stream/{stream_id}/tags/action

{
  "action" : "delete",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value3"
  } ]
}

Example Responses¶

None

Status Codes¶

Status Code	Description
204	Normal response.

Error Codes¶

See Error Codes.

last updated: 2024-09-09 11:26 UTC - commit: 5eda4327322823a5e0c9a8231f53e2e8533b4b22