Enabling or Disabling Alarm Rules in Batches
Function
This API is used to enable or disable alarm rules in batches.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
POST /v2/{project_id}/alarms/action
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Tenant ID. Constraints: None Value range: Project ID, 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 by calling an API or on the console. For details, see Obtaining a Project ID. The value must contain of 1 to 64 characters. Default value: None |
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. Default value: 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 |
IDs of alarm rules to be enabled or disabled in batches. |
alarm_enabled |
Yes |
Boolean |
Whether to enable the alarm rule. true: enabled; false: disabled. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
alarm_ids |
Array of strings |
IDs of alarm rules that were enabled or disabled. |
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
Enabling or disabling 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 |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot