ListCloudSiemPredefinedRules - Security Center - Alibaba Cloud Documentation Center

Retrieves a list of predefined 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:ListCloudSiemPredefinedRules

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	string	No	The rule ID.	10223
StartTime	integer	No	The start of the time range to query. This value is a UNIX timestamp in milliseconds.	1577808000000
EndTime	integer	No	The end of the time range to query. This value is a UNIX timestamp in 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 rule name. The name can contain only letters, digits, underscores (_), and periods (.).	waf_scan
RuleType	string	No	The rule type. Valid values: predefine: predefined customize: custom	customize
EventTransferType	string	No	The event generation method. Valid values: default: the default built-in method singleToSingle: An event is generated for each alert. allToSingle: An event is generated for all alerts in an epoch.	allToSingle
AttCk	string	No	The ATT&CK technique.	T1595.002 Vulnerability Scanning
LogSource	string	No	The log source.	cloud_siem_alb_flow_log
Status	integer	No	The rule status. Valid values: 0: initial 10: testing with simulated data 15: testing with production data 20: testing with production data is complete 100: published	0
OrderField	string	No	The field to sort the rules by. Valid values: GmtModified: Sorts by modification time. Id: Sorts by rule ID. This is the default value.	Id
Order	string	No	The sort order. Valid values: desc: descending asc: ascending	desc
CurrentPage	integer	Yes	The page number. The value must be greater than or equal to 1.	1
PageSize	integer	Yes	The number of entries per page. The maximum value is 100.	10
RoleType	integer	No	The view type. 0: the view of the current Alibaba Cloud account. 1: the view of all accounts in the enterprise.	1
RoleFor	integer	No	The user ID that the administrator uses to switch to the perspective of a member.	113091674488****
RegionId	string	No	The region where the Data Management center of the threat analysis feature is located. Select the region where your assets are located. Valid values: cn-hangzhou: assets in the Chinese mainland or China (Hong Kong) ap-southeast-1: assets outside China	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	PageResponse<List>
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 returned per page.	10
TotalCount	integer	The total number of entries.	100
ResponseData	array<object>	The detailed data.
	object
Id	integer	The ID of the predefined rule.	123456789
GmtCreate	string	The time when the rule was created.	2021-01-06 16:37:29
GmtModified	string	The time when the rule was last modified.	2021-01-06 16:37:29
RuleName	string	The rule name.	siem_base64-command-exec_aegis-proc
RuleNameCn	string	The Chinese name of the rule.	siem_base64-command-exec_aegis-proc
RuleNameEn	string	The English name of the rule.	siem_base64-command-exec_aegis-proc
RuleNameMds	string	The Medusa code of the rule name.	${siem_rule_name_siem_cfw-attack-count-level-up_cfw-attack}
RuleDescMds	string	The Medusa code of the rule description.	${siem_rule_description_siem_cfw-attack-count-level-up_cfw-attack}
ThreatLevel	string	The threat level. Valid values: serious: high suspicious: medium remind: low	remind
AlertType	string	The threat type.	WEBSHELL
Source	string	The log source of the rule.	cloud_siem_aegis_proc
EventTransferType	string	The event generation method. Valid values: default: the default built-in method singleToSingle: An event is generated for each alert. allToSingle: An event is generated for all alerts in an epoch.	allToSingle
AttCk	string	The ATT&CK technique.	T1595.002 Vulnerability Scanning
Status	integer	The status of the predefined rule. Valid values: 0: initial 100: published	0

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

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.