Help Center/ Cloud Eye/ API Reference/ API v2/ Alarm Templates/ Deleting Custom Alarm Templates in Batches

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

View PDF

Deleting Custom Alarm Templates in Batches

This API is used to delete custom alarm templates in batches.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

POST /v2/{project_id}/alarm-templates/batch-delete

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the tenant ID. Minimum: 1 Maximum: 64

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the tenant token. Minimum: 1 Maximum: 16384

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
template_ids	Yes	Array of strings	Specifies IDs of alarm templates to be deleted in batches. Alarm templates that are not associated with alarm rules can be deleted in batches. For alarm templates that are associated with alarm rules, you can delete only one alarm template at a time. If you delete multiple ones, an exception will be returned. Array Length: 1 - 100
delete_associate_alarm	Yes	Boolean	Specifies whether alarm rules associated with an alarm template will be deleted when you delete the alarm template. true indicates that the alarm rules will be deleted. false indicates that only the alarm template will be deleted.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
template_ids	Array of strings	Specifies IDs of alarm templates that were deleted successfully. Array Length: 1 - 100

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Deleting custom alarm templates in batches

{
  "template_ids" : [ "at1628592157541dB1klWgY6" ],
  "delete_associate_alarm" : false
}

Status code: 200

Specifies IDs of alarm templates that were successfully deleted.

{
  "template_ids" : [ "at1628592157541dB1klWgY6" ]
}

Status Code	Description
200	Specifies IDs of alarm templates that were successfully deleted.
400	Failed to verify parameters.
401	Not authenticated.
403	Authentication failed.
500	Internal system error.