This API is used to batch enable or disable alarm rules for one service that has one-click monitoring enabled.
PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarm-rules/action
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}$ |
one_click_alarm_id |
Yes |
String |
One-click monitoring ID. Minimum: 1 Maximum: 64 Regular expression matching: ^([a-z]|[A-Z]|[0-9]){1,64}$ |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
Content-Type |
Yes |
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 |
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 |
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. The value can be true (enable) or false (disable). |
Status code: 200
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
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
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
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: 404
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
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 |
Batch enable or disable alarm rules for a service in one-click monitoring.
PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarm-rules/action
Request body:
{
"alarm_ids" : [ "al1759030688878rovaxxxxx" ],
"alarm_enabled" : true
}
Status code: 200
Alarm rules enabled or disabled.
{
"alarm_ids" : [ "al1759030688878rovaxxxxx" ]
}
Status Code |
Description |
|---|---|
200 |
Alarm rules enabled or disabled. |
400 |
Parameter verification failed. |
401 |
Authentication failed. |
403 |
Authentication failed. |
404 |
Resources not found. |
500 |
Failed to complete the request because of an internal server error. |
See Error Codes.