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

23 KiB

Raw Blame History

Enabling or Disabling Alarm Rules in Batches

Function

This API is used to enable or disable alarm rules in batches.

URI

POST /v2/{project_id}/alarms/action

**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
Content-Type	No	String	MIME type of the request body. The default value is application/json; charset=UTF-8. Default: application/json; charset=UTF-8 Minimum: 1 Maximum: 64
X-Auth-Token	No	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
alarm_ids	Yes	Array of strings	IDs of alarm rules to be enabled or disabled in batches. Array length: 1 to 100
alarm_enabled	Yes	Boolean	Whether to generate alarms when the alarm triggering conditions are met.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
alarm_ids	Array of strings	IDs of alarm rules that were enabled or disabled. 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: 500

**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

Example Requests

Enable or disable alarm rules in batches.

{
  "alarm_ids" : [ "al12345678901234567890" ],
  "alarm_enabled" : true
}

Example Responses

Status code: 200

Alarm rules enabled or disabled.

{
  "alarm_ids" : [ "alCzk8o9dtSQHtiDgb44Eepw" ]
}

Status Codes

Status Code	Description
200	Alarm rules enabled or disabled.
400	Parameter verification failed.
500	Failed to complete the request because of an internal server error.

Error Codes

See Error Codes.

Parent topic: Alarm Rules

23 KiB Raw Blame History