获取自定义规则列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-sas:ListCloudSiemCustomizeRules | list |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Id | string | 否 | 自定义规则 ID。 | 10223 |
StartTime | long | 否 | 查询开始时间,单位毫秒。 | 1577808000000 |
EndTime | long | 否 | 查询结束时间,单位毫秒。 | 1577808000000 |
ThreatLevel | array | 否 | 威胁等级,JSON 数组格式。取值:
| |
string | 否 | 威胁等级,JSON 数组格式。取值:
| ["remind","serious"] | |
AlertType | string | 否 | 告警类型。 | scan |
RuleName | string | 否 | 规则名称,仅支持字母、数字、下划线、点。 | waf_scan |
RuleType | string | 否 | 规则类型。取值:
| customize |
Status | integer | 否 | 规则状态。取值:
| 0 |
OrderField | string | 否 | 规则列表排列字段。 取值:
| Id |
Order | string | 否 | 事件列表排列方向。 取值:
| desc |
CurrentPage | integer | 是 | 列表当前页号,大于等于 1。 | 1 |
PageSize | integer | 是 | 列表每页条数,最大不超过 100。 | 10 |
RoleType | integer | 否 | 视图类型。
| 1 |
RoleFor | long | 否 | 管理员切换成其他成员视角的用户 ID。 | 113091674488**** |
RegionId | string | 否 | 威胁分析的数据管理中心所在地。您需要根据资产所在地域,选择管理中心所在地。取值:
| cn-hangzhou |
返回参数
示例
正常返回示例
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,
"RuleName": "waf_scan",
"RuleDesc": "this rule is for waf scan",
"RuleType": "customize",
"ThreatLevel": "remind",
"AlertType": "WEBSHELL",
"AlertTypeMds": "${siem_rule_type_process_abnormal_command}",
"LogType": "ALERT_ACTIVITY",
"LogTypeMds": "${sas.cloudsiem.prod.alert_activity}",
"LogSource": "cloud_siem_aegis_sas_alert",
"LogSourceMds": "${sas.cloudsiem.prod.cloud_siem_aegis_sas_alert}",
"RuleCondition": "[[{"not":false,"left":"alert_name","operator":"=","right":"WEBSHELL"}]]",
"RuleGroup": "["asset_id"]",
"RuleThreshold": "{"aggregateFunction":"count","aggregateFunctionName":"count","field":"activity_name","operator":"<=","value":1}",
"QueryCycle": "{"time":"1","unit":"HOUR"}",
"AttCk": "T1595.002 Vulnerability Scanning",
"EventTransferSwitch": 1,
"EventTransferType": "allToSingle",
"EventTransferExt": "{"time":"1","unit":"MINUTE"}",
"Status": 0,
"DataType": 1
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError | The request processing has failed due to some unknown error. | 服务发生某些未知错误,请稍后再试 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-04-17 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |