ListCloudSiemCustomizeRules - Security Center - Alibaba Cloud Documentation Center

Retrieves a list of custom rules.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:ListCloudSiemCustomizeRules

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	string	No	The ID of the custom rule.	10223
StartTime	integer	No	The start time of the query. The value is a UNIX timestamp. Unit: milliseconds.	1577808000000
EndTime	integer	No	The end time of the query. The value is a UNIX timestamp. Unit: milliseconds.	1577808000000
ThreatLevel	array	No	The threat level. The value is a JSON array. Valid values: serious: high suspicious: medium remind: low	["serious","suspicious","remind"]
	string	No	The threat level. The value is a JSON array. Valid values: serious: high suspicious: medium remind: low	["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: predefined customize: custom	customize
Status	integer	No	The status of the rule. Valid values: 0: initial 10: testing with simulated data 15: testing with business data 20: testing with business data is complete 100: published	0
OrderField	string	No	The field that you use to sort the custom rules. Valid values: GmtModified: sorts the rules by modification time. Id: sorts the rules by rule ID. This is the default value.	Id
Order	string	No	The order in which you want to sort the custom rules. 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. Maximum value: 100.	10
RoleType	integer	No	The view type. 0: the view of the current Alibaba Cloud account. 1: the view of all members in the enterprise.	1
RoleFor	integer	No	The user ID that is used to switch the administrator's view to the view of a member.	113091674488****
RegionId	string	No	The region where the data management center of Threat Analysis is deployed. You must select the region where your assets reside. Valid values: cn-hangzhou: your assets are in the Chinese mainland or Hong Kong (China). ap-southeast-1: your assets are outside China.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	PageResponse<List<CloudSiemCustomizeRule>>
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	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.	123456
PageInfo	object	The pagination information.
CurrentPage	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries.	100
ResponseData	array<object>	The detailed data.
	object
Id	integer	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	integer	The ID of the Alibaba Cloud account.	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: predefined customize: custom	customize
ThreatLevel	string	The threat level. Valid values: serious: high suspicious: medium remind: low	remind
AlertType	string	The threat type.	WEBSHELL
AlertTypeMds	string	The Medusa code of the threat type.	${siem_rule_type_process_abnormal_command}
LogType	string	The log type that is associated with the rule.	ALERT_ACTIVITY
LogTypeMds	string	The Medusa code of the log type that is associated with the rule.	${sas.cloudsiem.prod.alert_activity}
LogSource	string	The log source that is associated with the rule.	cloud_siem_aegis_sas_alert
LogSourceMds	string	The Medusa code of the log source that is associated with the rule.	${sas.cloudsiem.prod.cloud_siem_aegis_sas_alert}
RuleCondition	string	The query condition of the rule, which is a JSON-formatted string that represents an array. You must unescape the HTML escape characters in the string.	[[{"not":false,"left":"alert_name","operator":"=","right":"WEBSHELL"}]]
RuleGroup	string	The aggregation field of the log, which is a JSON-formatted string that represents an array. You must unescape the HTML escape characters in the string.	["asset_id"]
RuleThreshold	string	The threshold of the rule, which is a JSON-formatted string. You must unescape the HTML escape characters in the string.	{"aggregateFunction":"count","aggregateFunctionName":"count","field":"activity_name","operator":"<=","value":1}
QueryCycle	string	The window length of the rule, which is a JSON-formatted string. You must unescape the HTML escape characters in the string.	{"time":"1","unit":"HOUR"}
AttCk	string	The ATT&CK attack technique.	T1595.002 Vulnerability Scanning
EventTransferSwitch	integer	Indicates whether to convert alerts into events. Valid values: 0: no 1: yes	1
EventTransferType	string	The event generation method. Valid values: default: the default method singleToSingle: An event is generated for each alert. allToSingle: An event is generated for all alerts within a period.	allToSingle
EventTransferExt	string	The extended information for event generation. This parameter is returned only when EventTransferType is set to allToSingle. The value is a JSON-formatted string that indicates the window length and unit for alert aggregation. You must unescape the HTML escape characters in the string.	{"time":"1","unit":"MINUTE"}
Status	integer	The status of the rule. Valid values: 0: initial 10: testing with simulated data 15: testing with business data 20: testing with business data is complete 100: published	0
DataType	integer	The view type. 0: the view of the current Alibaba Cloud account. 1: the view of all members in the enterprise.	1

Examples

Success response

JSON format

{
  "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
      }
    ]
  }
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.