Batch Enabling or Disabling Alarm Rules for One Service with One-Click Monitoring Enabled
Function
This API is used to batch enable or disable alarm rules for one service with one-click monitoring enabled.
URI
PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarms/{alarm_id}/policies/action
| 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 |
| one_click_alarm_id | Yes | String | One-click monitoring ID for a service. |
| alarm_id | Yes | String | Alarm rule ID. |
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_policy_ids | Yes | Array of strings | IDs of alarm policies to be enabled or disabled in batches in an alarm rule. |
| enabled | Yes | Boolean | Whether to enable the alarm policy. true: enabled; false: disabled. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| alarm_policy_ids | Array of strings | IDs of alarm policies that were enabled or disabled in batches in an alarm rule. |
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: 401
| 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
| 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: 404
| 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
{
"alarm_policy_ids" : [ "alxdxxxdsw12321321" ],
"enabled" : true
} Example Responses
Status code: 200
Alarm rules enabled or disabled.
{
"alarm_policy_ids" : [ "alxdxxxdsw12321321" ]
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Alarm rules enabled or disabled. |
| 400 | Parameter verification failed. |
| 401 | Not authenticated. |
| 403 | Authentication failed. |
| 404 | Resource not found. |
| 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.