添加或者更新自定义规则。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| yundun-sas:PostCustomizeRule | Write |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Id | long | 否 | 自定义规则 ID。 | 123456789 |
| RuleName | string | 否 | 规则名称。 | waf_scan |
| RuleDesc | string | 否 | 规则描述。 | this rule is for waf scan |
| ThreatLevel | string | 否 | 威胁等级。取值：
| remind |
| AlertType | string | 否 | 威胁类型。 | WEBSHELL |
| AlertTypeMds | string | 否 | 威胁类型美杜莎 Code。 | ${siem_rule_type_process_abnormal_command} |
| LogType | string | 否 | 规则对应的日志类型。 | ALERT_ACTIVITY |
| LogTypeMds | string | 否 | 规则对应的日志类型美杜莎 Code。 | ${security_event_config.event_name.webshellName_clientav} |
| LogSource | string | 否 | 规则对应的日志源。 | cloud_siem_aegis_sas_alert |
| LogSourceMds | string | 否 | 规则对应的日志源美杜莎 Code。 | ${sas.cloudsiem.prod.cloud_siem_aegis_sas_alert} |
| RuleCondition | string | 否 | 规则查询条件 json。 | [[{"not":false,"left":"alert_name","operator":"=","right":"WEBSHELL"}]] |
| RuleGroup | string | 否 | 日志聚合字段，json 数组格式。 | ["asset_id"] |
| RuleThreshold | string | 否 | 规则阈值配置 json。 | {"aggregateFunction":"count","aggregateFunctionName":"count","field":"activity_name","operator":"<=","value":1} |
| QueryCycle | string | 否 | 规则窗口长度。 | {"time":"1","unit":"HOUR"} |
| EventTransferSwitch | integer | 否 | 告警是否转换事件开关。取值：
| 1 |
| EventTransferType | string | 否 | 事件生成方式。取值：
| allToSingle |
| EventTransferExt | string | 否 | 事件生成扩展信息，当 eventTransferType 值为 allToSingle 时，该字段有值，表示告警聚合窗口的周期长度以及周期单位。 | {"time":"1","unit":"MINUTE"} |
| RegionId | string | 否 | 威胁分析的数据管理中心所在地。您需要根据资产所在地域，选择管理中心所在地。取值：
| cn-hangzhou |
返回参数
示例
正常返回示例
JSON格式
{
"Success": true,
"Code": 200,
"Message": "success",
"RequestId": "9AAA9ED9-78F4-5021-86DC-D51C7511****",
"Data": {
"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": "${security_event_config.event_name.webshellName_clientav}",
"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"}",
"EventTransferSwitch": 1,
"EventTransferType": "allToSingle",
"EventTransferExt": "{"time":"1","unit":"MINUTE"}",
"Status": 0
}
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 400 | CloudSiemCustomizeRuleUpdateExcepiton | this customize rule can only update in init status. |
| 400 | CloudSiemCustomizeRuleConditionExceedExcepiton | the number of rule conditions cannot exceed 100. |
| 400 | CloudSiemCustomizeRuleDuplicateRuleNameExcepiton | the rule name is duplicated. |
| 501 | CloudSiem_Internal_Exception | CloudSiem_Internal_Exception |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2024-04-17 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||||||||
|