ListCloudSiemCustomizeRules - Security Center - Alibaba Cloud Documentation Center

Queries custom rules.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Id	string	No	The ID of the custom rule.	10223
StartTime	long	No	The beginning of the time range to query. Unit: milliseconds.	1577808000000
EndTime	long	No	The end of the time range to query. Unit: milliseconds.	1577808000000
ThreatLevel	array	No	The threat level. The value must be a JSON array. Valid values: serious: high-risk. suspicious: medium-risk. remind: low-risk.
	string	No	The threat level. The value must be a JSON array. Valid values: serious: high-risk. suspicious: medium-risk. remind: low-risk.	["remind","serious"]
AlertType	string	No	The alert type.	scan
RuleName	string	No	The name of the rule. The name can contain letters, digits, underscores (_), and periods (.).	waf_scan
RuleType	string	No	The type of the rule. Valid values: predefine customize	customize
Status	integer	No	The status of the rule. Valid values: 0: The rule is in the initial state. 10: The simulation data is tested. 15: The business data is being tested. 20: The business data test is complete. 100: The rule is in effect.	0
OrderField	string	No	The field that is used to sort the rules. Valid values: GmtModified: The rules are sorted based on the modification time. Id (default): The rules are sorted based on the rule ID.	Id
Order	string	No	The sort method. Valid values: desc: descending order. asc: ascending order.	desc
CurrentPage	integer	Yes	The page number. Pages start from page 1.	1
PageSize	integer	Yes	The number of entries per page. The value can be up to 100.	10
RoleType	integer	No	The type of the view. Valid values: 0: view of the current Alibaba Cloud account. 1: view of all accounts for the enterprise.	0
RoleFor	long	No	The ID of the destination account to which you switch the view from the management account.	113091674488****
RegionId	string	No	The data management center of the threat analysis feature. Specify this parameter based on the regions in which your assets reside. Valid values: cn-hangzhou: Your assets reside in regions in China. ap-southeast-1: Your assets reside in regions outside China.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	PageResponse<List>
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Code	integer	The HTTP status code.	200
Message	string	The returned message.	success
RequestId	string	The request ID.	9AAA9ED9-78F4-5021-86DC-D51C7511****
Data	object	The data returned.
PageInfo	object	The pagination information.
CurrentPage	integer	The current page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	long	The total number of entries returned.	100
ResponseData	object []	The detailed data.
Id	long	The ID of the custom rule.	123456789
GmtCreate	string	The time when the custom rule was created.	2021-01-06 16:37:29
GmtModified	string	The time when the custom rule was last updated.	2021-01-06 16:37:29
Aliuid	long	The ID of the Alibaba Cloud account in SIEM.	127608589417****
RuleName	string	The name of the rule.	waf_scan
RuleDesc	string	The description of the rule.	this rule is for waf scan
RuleType	string	The type of the rule. Valid values: predefine customize	customize
ThreatLevel	string	The risk level. Valid values: serious: high-risk. suspicious: medium-risk. remind: low-risk.	remind
AlertType	string	The type of the risk.	WEBSHELL
AlertTypeMds	string	The internal code of the risk type.	${siem_rule_type_process_abnormal_command}
LogType	string	The log type of the rule.	ALERT_ACTIVITY
LogTypeMds	string	The internal code of the log type.	${sas.cloudsiem.prod.alert_activity}
LogSource	string	The log source of the rule.	cloud_siem_aegis_sas_alert
LogSourceMds	string	The internal code of the log source.	${sas.cloudsiem.prod.cloud_siem_aegis_sas_alert}
RuleCondition	string	The query condition of the rule. The value is in the JSON format. The HTML escape characters are reversed.	[[{"not":false,"left":"alert_name","operator":"=","right":"WEBSHELL"}]]
RuleGroup	string	The log aggregation field. The value is in the JSON format. The HTML escape characters are reversed.	["asset_id"]
RuleThreshold	string	The threshold configurations of the rule in the JSON format. The HTML escape characters are reversed.	{"aggregateFunction":"count","aggregateFunctionName":"count","field":"activity_name","operator":"<=","value":1}
QueryCycle	string	The window length of the rule. The HTML escape characters are reversed.	{"time":"1","unit":"HOUR"}
AttCk	string	The alert additional field for ATT&CK.	T1595.002 Vulnerability Scanning
EventTransferSwitch	integer	Indicates whether the system generates an event for the alert. Valid values: 0: no. 1: yes.	1
EventTransferType	string	The method that is used to generate an event. Valid values: default: built-in method. singleToSingle: The system generates an event for each alert. allToSingle: The system generates an event for alerts within a period of time.	allToSingle
EventTransferExt	string	The extended information about event generation. If the value of eventTransferType is allToSingle, the value of this parameter indicates the length and unit of the alert aggregation window. The HTML escape characters are reversed.	{"time":"1","unit":"MINUTE"}
Status	integer	The status of the rule. Valid values: 0: The rule is in the initial state. 10: The simulation data is tested. 15: The business data is being tested. 20: The business data test is complete. 100: The rule is in effect.	0
DataType	integer	The type of the view. Valid values: 0: view of the current Alibaba Cloud account. 1: view of all accounts for the enterprise.	1

Examples

Sample success responses

JSONformat

{
  "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": "[[{&quot;not&quot;:false,&quot;left&quot;:&quot;alert_name&quot;,&quot;operator&quot;:&quot;=&quot;,&quot;right&quot;:&quot;WEBSHELL&quot;}]]",
        "RuleGroup": "[&quot;asset_id&quot;]",
        "RuleThreshold": "{&quot;aggregateFunction&quot;:&quot;count&quot;,&quot;aggregateFunctionName&quot;:&quot;count&quot;,&quot;field&quot;:&quot;activity_name&quot;,&quot;operator&quot;:&quot;&lt;=&quot;,&quot;value&quot;:1}",
        "QueryCycle": "{&quot;time&quot;:&quot;1&quot;,&quot;unit&quot;:&quot;HOUR&quot;}",
        "AttCk": "T1595.002 Vulnerability Scanning",
        "EventTransferSwitch": 1,
        "EventTransferType": "allToSingle",
        "EventTransferExt": "{&quot;time&quot;:&quot;1&quot;,&quot;unit&quot;:&quot;MINUTE&quot;}",
        "Status": 0,
        "DataType": 1
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
500	InternalError	The request processing has failed due to some unknown error.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2024-04-17

The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 501
	Added Error Codes: 500
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: OrderField
	Added Input Parameters: Order
	Added Input Parameters: RoleType
	Added Input Parameters: RoleFor
Output Parameters	The response structure of the API has changed.