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.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

ces:customAlarmTemplates:delete

Write

-

g:EnterpriseProjectId

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ces:customAlarmTemplates:delete	Write	-	g:EnterpriseProjectId	-	-

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. It is used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID from the API or console. For details, see Obtaining a Project ID. Constraints N/A Range 1 to 64 characters. Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Definition User token. Constraints: None Value range: The value can contain 1 to 16,384 characters. Default value: None

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
template_ids	Yes	Array of strings	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.
delete_associate_alarm	Yes	Boolean	Definition Whether to delete alarm rules associated with the alarm template. Constraints N/A Range true: deletes the alarm rules as well. false: deletes only the alarm template. Default Value false

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
template_ids	Array of strings	IDs of alarm templates that were deleted successfully.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Deleting custom alarm templates in batches.

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

Status code: 200

IDs of alarm templates successfully deleted.

{
  "template_ids" : [ "at1628592157541dB1klWgY6" ]
}

Status Code	Description
200	IDs of alarm templates successfully deleted.
400	Parameter verification failed.
401	Not authenticated.
403	Authentication failed.
500	Internal system error.

Parent topic: Alarm Templates

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.