停用告警规则
功能介绍
Disable alert rule
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/siem/alert-rules/disable
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目 ID。Project ID. |
| workspace_id | 是 | String | 工作空间 ID。Workspace ID. |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token,通过调用IAM服务获取用户Token接口获取。 IAM user token, fetch from IAM api. |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| [数组元素] | 是 | Array of strings | 禁用告警规则的请求 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| fail_list | Array of AlertRule objects | Alert rule ID. |
| success_list | Array of AlertRule objects | Alert rule ID. |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| rule_id | String | 告警规则 ID。Alert rule ID. |
| pipe_id | String | 数据管道 ID。Pipe ID. |
| pipe_name | String | 数据管道名称。Pipe name. |
| create_by | String | 创建人。Create by. |
| create_time | Long | 创建时间。Create time. |
| update_by | String | 更新人。Update by. |
| update_time | Long | 更新时间。Update time. |
| delete_time | Long | 删除时间。Delete time. |
| rule_name | String | 告警规则名称。Alert rule name. |
| query | String | 查询语句。Query. |
| query_type | String | 查询语法,SQL。Query type. SQL. |
| status | String | 启用状态,启用、停用。Status, enabled, disabled. |
| severity | String | 严重程度,提示、低危、中危、高危、致命。Severity. TIPS, LOW, MEDIUM, HIGH, FATAL |
| custom_properties | Map<String,String> | 自定义扩展信息。Custom properties. |
| event_grouping | Boolean | 告警分组。Event grouping. |
| schedule | Schedule object | 调度规则。Schedule Rule. |
| triggers | Array of AlertRuleTrigger objects | 告警触发规则。Alert triggers. |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| frequency_interval | Integer | 调度间隔。Frequency interval. |
| frequency_unit | String | 调度间隔单位,分钟、小时、天。Frequency unit. MINUTE, HOUR, DAY. |
| period_interval | Integer | 时间窗口间隔。Period interval. |
| period_unit | String | 时间窗口单位,分钟、小时、天。Period unit. MINUTE, HOUR, DAY. |
| delay_interval | Integer | 延迟间隔。Delay interval |
| overtime_interval | Integer | 超时间隔。Overtime interval |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| mode | String | 模式,数量。Mode. COUNT. |
| operator | String | 操作符,等于、不等于、大于、小于。 operator. EQ equal, NE not equal, GT greater than, LT less than. |
| expression | String | expression |
| severity | String | 严重程度,提示、低危、中危、高危、致命。Severity. TIPS, LOW, MEDIUM, HIGH, FATAL |
| accumulated_times | Integer | accumulated_times |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. |
请求示例
停用告警规则,ID为123123
[ "123123" ]
响应示例
状态码:200
请求成功
{
"fail_list" : [ ],
"success_list" : [ ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
| 400 | 请求失败 |
错误码
请参见错误码。