调用ListCloudSiemPredefinedRules API获取预定义规则列表-云安全中心-阿里云

获取预定义规则列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:ListCloudSiemPredefinedRules

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Id	string	否	规则 ID。	10223
StartTime	integer	否	查询开始时间, 单位毫秒。	1577808000000
EndTime	integer	否	查询结束时间, 单位毫秒。	1577808000000
ThreatLevel	array	否	威胁等级，格式为 json 数组。取值： serious：高危 suspicious：中危 remind：低危	["serious","suspicious","remind"]
	string	否	威胁等级，格式为 json 数组。取值： serious：高危 suspicious：中危 remind：低危	["remind","serious"]
AlertType	string	否	告警类型。	scan
RuleName	string	否	规则名称, 仅支持字母、数字、下划线、点。	waf_scan
RuleType	string	否	规则类型。取值： predefine：预定义 customize：自定义	customize
EventTransferType	string	否	事件生成方式。取值： default:默认内置方式 singleToSingle：每个告警生成一个事件 allToSingle：周期内告警生成一个事件	allToSingle
AttCk	string	否	att&ck。	T1595.002 Vulnerability Scanning
LogSource	string	否	日志源。	cloud_siem_alb_flow_log
Status	integer	否	规则状态。取值： 0：初始状态 10：模拟数据测试 15：业务数据测试中 20：业务数据测试结束 100：规则上线	0
OrderField	string	否	规则列表排列字段。取值： GmtModified：基于修改时间排序 Id：基于规则 id 排序（默认）	Id
Order	string	否	事件列表排列方向。取值： desc：降序排列 asc：升序排列。	desc
CurrentPage	integer	是	列表当前页号，大于等于 1。	1
PageSize	integer	是	列表每页条数，最大不超过 100。	10
RoleType	integer	否	视图类型。 0：当前阿里云账号视图。 1：企业下所有账号的视图。	1
RoleFor	integer	否	管理员切换成其他成员视角的用户 ID。	113091674488****
RegionId	string	否	威胁分析的数据管理中心所在地。您需要根据资产所在地域，选择管理中心所在地。取值： cn-hangzhou：资产属于中国内地与中国香港 ap-southeast-1：资产属于海外地域	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	PageResponse<List>
Success	boolean	请求是否成功。取值： true：成功 false：失败	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
RuleName	string	规则名称。	siem_base64-command-exec_aegis-proc
RuleNameCn	string	规则中文名称。	siem_base64-command-exec_aegis-proc
RuleNameEn	string	规则英文名称。	siem_base64-command-exec_aegis-proc
RuleNameMds	string	规则名称美杜莎 Code。	${siem_rule_name_siem_cfw-attack-count-level-up_cfw-attack}
RuleDescMds	string	规则描述美杜莎 Code。	${siem_rule_description_siem_cfw-attack-count-level-up_cfw-attack}
ThreatLevel	string	威胁等级。取值： serious：高危 suspicious：中危 remind：低危	remind
AlertType	string	威胁类型。	WEBSHELL
Source	string	规则对应的日志源。	cloud_siem_aegis_proc
EventTransferType	string	事件生成方式。取值： default:默认内置方式 singleToSingle：每个告警生成一个事件 allToSingle：周期内告警生成一个事件	allToSingle
AttCk	string	告警附加字段 attck	T1595.002 Vulnerability Scanning
Status	integer	预定义规则启用状态。取值： 0：初始状态 100：规则上线	0

示例

正常返回示例

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",
        "RuleName": "siem_base64-command-exec_aegis-proc",
        "RuleNameCn": "siem_base64-command-exec_aegis-proc",
        "RuleNameEn": "siem_base64-command-exec_aegis-proc",
        "RuleNameMds": "${siem_rule_name_siem_cfw-attack-count-level-up_cfw-attack}",
        "RuleDescMds": "${siem_rule_description_siem_cfw-attack-count-level-up_cfw-attack}",
        "ThreatLevel": "remind",
        "AlertType": "WEBSHELL",
        "Source": "cloud_siem_aegis_proc",
        "EventTransferType": "allToSingle",
        "AttCk": "T1595.002 Vulnerability Scanning",
        "Status": 0
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	The request processing has failed due to some unknown error.	服务发生某些未知错误，请稍后再试

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。