Batch Deleting Alarm Rules
Function
This API (V2) is used to batch delete alarm rules.
URI
POST /v2/{project_id}/alarms/batch-delete
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 |
Request Parameters
Parameter | Mandatory | Type | Description |
|---|---|---|---|
Content-Type | No | String | Definition MIME type of the request body. Constraints: None Value range: The value can contain 1 to 64 characters. Default value: The default type is application/json; charset=UTF-8. |
X-Auth-Token | No | String | Definition User token. Constraints: None Value range: The value can contain 1 to 16,384 characters. Default value: None |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
alarm_ids | Yes | Array of strings | Definition IDs of the alarm rules to be deleted in batches. Constraints At least one and a maximum of 10 alarm rule IDs can be configured. |
Response Parameters
Status code: 200
Parameter | Type | Description |
|---|---|---|
alarm_ids | Array of strings | Definition IDs of the alarm rules that are deleted. |
Status code: 400
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
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. |
Example Requests
Deleting alarm rules in batches.
{
"alarm_ids" : [ "al12345678901234567890" ]
} Example Responses
Status code: 200
Alarm rule deleted.
{
"alarm_ids" : [ "alCzk8o9dtSQHtiDgb44Eepw" ]
} Status Codes
Status Code | Description |
|---|---|
200 | Alarm rule deleted. |
400 | Parameter verification failed. |
500 | Internal system error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.

