删除告警白名单 - RemoveAlarmWhiteList
功能介绍
删除告警白名单
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
DELETE /v5/{project_id}/event/white-list/alarm
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
data_list |
否 |
Array of AlarmWhiteListRequestInfo objects |
参数解释 : "删除告警白名单详情" 删除条件以data_list优先: 1、删除具体某些白名单时,data_list必需,delete_all可以不填。(data_list内hash、description、event_type必需,确定要删除白名单规则时delete_white_rule必须为true) 2、删除所有白名单时(delete_all 必须为true),data_list一定不要传。 约束限制 : 不涉及 取值范围 : 最小值0,最大值100 默认取值 : 不涉及 |
|
restore_alarm |
否 |
Boolean |
参数解释: 是否需要恢复相关告警 约束限制: 不涉及 取值范围:
默认取值: false |
|
delete_all |
否 |
Boolean |
参数解释: 是否删除所有白名单内容 1、删除所有白名单时,必须填。删除所有某种类型白名单时,请同时填写event_type参数 2、删除具体某些白名单时,请填写data_list。 约束限制: 不涉及 取值范围:
默认取值: false |
|
event_type |
否 |
Integer |
参数解释: 事件类型 取值范围:
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
event_type |
否 |
Integer |
参数解释: 事件类型 取值范围:
|
|
hash |
否 |
String |
参数解释: 事件白名单SHA256 约束限制: 不涉及 取值范围: 字符长度0-512位 默认取值: 不涉及 |
|
description |
否 |
String |
参数解释: 描述信息。 约束限制: 不涉及 取值范围: 字符长度0-64 默认取值: 不涉及 |
|
delete_white_rule |
否 |
Boolean |
参数解释: 是否删除告警白名单规则(仅删除的白名单是规则类型时使用) 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
white_field |
否 |
String |
参数解释: 加白字段 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
judge_type |
否 |
String |
参数解释: 通配符 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
field_value |
否 |
String |
参数解释: 加白字段值 约束限制: 不涉及 取值范围: 字符长度0-512位 默认取值: 不涉及 |
|
file_hash |
否 |
String |
参数解释: 文件哈希 约束限制: 不涉及 取值范围: 字符长度0-512位 默认取值: 不涉及 |
|
file_path |
否 |
String |
参数解释: 文件路径 约束限制: 不涉及 取值范围: 字符长度0-512位 默认取值: 不涉及 |
响应参数
状态码:200
请求已成功
无
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。