获取告警加白规则列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
yundun-sas:DescribeWhiteRuleList |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AlertType |
string |
否 |
告警类型。 |
scan |
| AlertName |
string |
否 |
告警名称。 |
Try SNMP weak password |
| IncidentUuid |
string |
否 |
事件全局唯一 UUID。 |
85ea4241-798f-4684-a876-65d4f0c3**** |
| CurrentPage |
integer |
是 |
列表当前页号, 大于等于 1。 |
1 |
| PageSize |
integer |
是 |
列表每页条数, 最大不超过 100。 |
10 |
| RoleType |
integer |
否 |
视图类型。
|
1 |
| RoleFor |
integer |
否 |
管理员切换成其他成员视角的用户 ID。 |
113091674488**** |
| RegionId |
string |
否 |
威胁分析的数据管理中心所在地。您需要根据资产所在地域,选择管理中心所在地。取值:
|
cn-hangzhou |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
PageResponse<List |
||
| Success |
boolean |
请求是否成功。取值:
|
true |
| Code |
integer |
请求状态码。 |
200 |
| Message |
string |
请求返回消息。 |
success |
| RequestId |
string |
请求 ID。 |
9AAA9ED9-78F4-5021-86DC-D51C7511**** |
| Data |
object |
请求返回值。 |
123456 |
| PageInfo |
object |
分页记录。 |
|
| CurrentPage |
integer |
列表当前页号。 |
1 |
| PageSize |
integer |
每页返回记录数。 |
10 |
| TotalCount |
integer |
记录总数。 |
100 |
| ResponseData |
array<object> |
详细数据。 |
|
|
object |
|||
| Id |
integer |
加白规则唯一 ID。 |
123456789 |
| GmtCreate |
string |
创建时间。 |
2021-01-06 16:37:29 |
| GmtModified |
string |
修改时间。 |
2021-01-06 16:37:29 |
| Aliuid |
integer |
开通威胁分析的阿里云账号 ID。 |
127608589417**** |
| SubAliuid |
integer |
创建规则的阿里云账号 ID。 |
176555323*** |
| AlertType |
string |
告警类型。 |
scan |
| AlertTypeId |
string |
告警类型标识。 |
scan |
| AlertName |
string |
告警名称。 |
Try SNMP weak password |
| AlertNameId |
string |
告警名称标识。 |
Try SNMP weak password |
| Status |
integer |
规则启用状态。 取值:
|
1 |
| IncidentUuid |
string |
事件全局唯一 UUID。 |
85ea4241-798f-4684-a876-65d4f0c3**** |
| AlertUuid |
string |
告警 UUID。 |
sas_71e24437d2797ce8fc59692905a4**** |
| Expression |
object |
规则集 json 数组格式。 |
[{"conditions":[{"isNot":false,"itemId":0,"left":{"value":"host_uuid.host_name"},"operator":"containsString","right":{"value":"Cloud-MCH"}}]}] |
| Logic |
string |
条件逻辑关系。 |
(1&2)|(3&4) |
| Conditions |
array<object> |
规则表达式数组。 |
|
|
object |
规则表达式数组。 |
||
| ItemId |
integer |
条件 ID。 |
1 |
| Operator |
string |
分派规则条件聚合方式。
|
REGEXP |
| IsNot |
boolean |
对结果是否取反。 取值:
|
false |
| Left |
object |
条件左值。 |
|
| Value |
string |
左值变量名称。 |
ip |
| IsVar |
boolean |
是否是变量。
|
true |
| Type |
string |
是否是常量。取值:
|
false |
| Modifier |
string |
备注信息。 |
length |
| ModifierParam |
object |
备注信息键值对。 |
|
|
any |
备注信息键值对。 |
{"tage":"description"} |
|
| Right |
object |
右值对象。 |
|
| Value |
string |
右值。 |
12345 |
| IsVar |
boolean |
指定右变量值是常量,还是运行时变量(从运行时上下文中获取具体值)。
|
false |
| Type |
string |
数据类型。 |
String |
| Modifier |
string |
备注信息。 |
length |
| ModifierParam |
object |
备注信息键值对。 |
|
|
any |
备注信息键值对。 |
{"tage":"description"} |
示例
正常返回示例
JSON格式
{
"Success": true,
"Code": 200,
"Message": "success",
"RequestId": "9AAA9ED9-78F4-5021-86DC-D51C7511****",
"Data": {
"PageInfo": {
"CurrentPage": 1,
"PageSize": 10,
"TotalCount": 100
},
"ResponseData": [
{
"Id": 123456789,
"GmtCreate": "2021-01-06 16:37:29",
"GmtModified": "2021-01-06 16:37:29",
"Aliuid": 0,
"SubAliuid": 0,
"AlertType": "scan",
"AlertTypeId": "scan",
"AlertName": "Try SNMP weak password",
"AlertNameId": "Try SNMP weak password",
"Status": 1,
"IncidentUuid": "85ea4241-798f-4684-a876-65d4f0c3****",
"AlertUuid": "sas_71e24437d2797ce8fc59692905a4****",
"Expression": {
"Logic": "(1&2)|(3&4)",
"Conditions": [
{
"ItemId": 1,
"Operator": "REGEXP",
"IsNot": false,
"Left": {
"Value": "ip",
"IsVar": true,
"Type": "false",
"Modifier": "length",
"ModifierParam": {
"key": "{\"tage\":\"description\"}"
}
},
"Right": {
"Value": "12345",
"IsVar": false,
"Type": "String",
"Modifier": "length",
"ModifierParam": {
"key": "{\"tage\":\"description\"}"
}
}
}
]
}
}
]
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 500 | InternalError | The request processing has failed due to some unknown error. | 服务发生某些未知错误,请稍后再试 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。