Files

qiujiandong1 e9265fb6b0 CES API Update -20250521 version

Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com>
Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com>
Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>

2025-12-05 10:48:24 +00:00

32 KiB

Raw Blame History

Batch Deleting Custom Alarm Templates

Function

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

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Minimum: 1 Maximum: 64 Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token. Minimum: 1 Maximum: 16384

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
template_ids	Yes	Array of strings	IDs of the 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 to 100
delete_associate_alarm	Yes	Boolean	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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
template_ids	Array of strings	IDs of alarm templates that were deleted. Array length: 1 to 100

Status code: 400

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

Status code: 401

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

Status code: 403

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

Status code: 500

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

Example Requests

Deleting custom alarm templates in batches

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

Example Responses

Status code: 200

IDs of the templates deleted.

{
  "template_ids" : [ "at1628592157541dB1klWgY6" ]
}

Status Codes

Status Code	Description
200	IDs of the templates deleted.
400	Parameter verification failed.
401	Authentication failed.
403	Authentication failed.
500	Failed to complete the request because of an internal server error.

Error Codes

See Error Codes.

Parent topic: Alarm Templates

32 KiB Raw Blame History