Enabling an Alert Rule
Function
Enable alert rule
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/siem/alert-rules/enable
| Parameter | Mandatory | Type | Description | 
|---|---|---|---|
| project_id | Yes | String | Project ID. Project ID. | 
| workspace_id | Yes | String | Workspace ID. Workspace ID. | 
Request Parameters
| Parameter | Mandatory | Type | Description | 
|---|---|---|---|
| X-Auth-Token | Yes | String | User token. You can obtain the token by calling the IAM API used to obtain a user token. Token of an IAM user. To obtain it, call the corresponding IAM API. | 
| Parameter | Mandatory | Type | Description | 
|---|---|---|---|
| [items] | Yes | Array of strings | EnableAlertRuleRequestBody | 
Response Parameters
Status code: 200
| Parameter | Type | Description | 
|---|---|---|
| X-request-id | String | This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. | 
| Parameter | Type | Description | 
|---|---|---|
| fail_list | Array of AlertRule objects | Alert rule ID. | 
| success_list | Array of AlertRule objects | Alert rule ID. | 
| Parameter | Type | Description | 
|---|---|---|
| rule_id | String | Alert rule ID. | 
| pipe_id | String | Pipeline ID.Pipe ID. | 
| pipe_name | String | Data pipeline name.Pipe name. | 
| create_by | String | Created by. Created by. | 
| create_time | Long | Creation time. Create time. | 
| update_by | String | Updated by. Update by. | 
| update_time | Long | Update time. Update time. | 
| delete_time | Long | The deletion time. Delete time. | 
| rule_name | String | Alert rule name. | 
| query | String | Query. | 
| query_type | String | SQL query syntax. Query type. SQL. | 
| status | String | Status. The options are as follows - Enabled - Disabled | 
| severity | String | Severity. The options are as follows - Tips - Low - Medium - High - FATAL. | 
| custom_properties | Map<String,String> | Custom extension information. Custom properties. | 
| event_grouping | Boolean | Alert group. Alert group. | 
| schedule | Schedule object | Schedule Rule. | 
| triggers | Array of AlertRuleTrigger objects | Alert triggering rules. Alert triggers. | 
| Parameter | Type | Description | 
|---|---|---|
| frequency_interval | Integer | Scheduling interval. Frequency interval. | 
| frequency_unit | String | The unit of the scheduling interval. The value can be minute, hour, or day. Frequency unit. MINUTE, HOUR, DAY. | 
| period_interval | Integer | Time window interval. Period interval. | 
| period_unit | String | Time Window unit. The value can be minute, hour, or day. Period unit. MINUTE, HOUR, DAY. | 
| delay_interval | Integer | The delay interval. Delay interval | 
| overtime_interval | Integer | Timeout interval. Overtime interval | 
| Parameter | Type | Description | 
|---|---|---|
| mode | String | Number of modes. Mode. COUNT. | 
| operator | String | Operator, which can be equal to, not equal to, greater than, or less than. operator. EQ equal, NE not equal, GT greater than, LT less than. | 
| expression | String | expression | 
| severity | String | Severity. The options are as follows - Tips - Low - Medium - High - FATAL. | 
| accumulated_times | Integer | accumulated_times | 
Status code: 400
| Parameter | Type | Description | 
|---|---|---|
| X-request-id | String | This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. | 
Example Requests
Enabling rule 123123
[ "123123" ]
Example Responses
Status code: 200
Success
{
  "fail_list" : [ ],
  "success_list" : [ ]
}
  Status Codes
| Status Code | Description | 
|---|---|
| 200 | Success | 
| 400 | Bad Request | 
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.
 
    