ListCustomizeRuleTestResult - Security Center - Alibaba Cloud Documentation Center

Retrieves the list of test results for a custom rule.

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:ListCustomizeRuleTestResult

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	No	The ID of the custom rule.	123456789
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 type of the view. 0: the view of the current Alibaba Cloud account. 1: the view of all accounts that belong to the enterprise.	1
RoleFor	integer	No	The user ID of a member. This parameter is used by an administrator to switch to the perspective of the member.	113091674488****
RegionId	string	No	The region where the Data Management center of Threat Analysis is located. Select a region based on the region where your assets are deployed. Valid values: cn-hangzhou: assets in the Chinese mainland and China (Hong Kong) ap-southeast-1: assets outside China	cn-hangzhou
DetectionRuleId	string	No	The ID of the custom rule. You can obtain the rule ID from the rule list.	dr-53np4nguf5jmh1vc****
VerifyType	string	No	The verification result for the accuracy of alert fields based on the alert template. true: The verification is passed. Alerts that are generated for enabled rules can be synchronized to the product. false: The verification failed. Alerts cannot be synchronized to the product.	true
StartTime	integer	No	The start time.	1723057091000
EndTime	integer	No	The end time.	1731797891000

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 status code of the request.	200
Message	string	The message returned for the request.	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 current page number.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of entries.	100
VerifiedCount	integer	The number of alerts that passed the verification.	30
ResponseData	array<object>	The detailed data.
	object
Uuid	string	The UUID of the alert.	sas_71e24437d2797ce8fc59692905a4****
MainUserId	string	The ID of the main Alibaba Cloud account for Security Information and Event Management (SIEM) that is associated with the alert.	127608589417****
SubUserId	string	The ID of the member account that is associated with the alert.	176555323***
LogType	string	The log type that corresponds to the rule.	ALERT_ACTIVITY
LogSource	string	The log source that corresponds to the rule.	cloud_siem_aegis_sas_alert
AlertSrcProd	string	The source product of the alert that is associated with the event.	sas
AlertSrcProdModule	string	The sub-module of the source product of the alert that is associated with the event.	waf
AttCk	string	The ATT&CK attack technique tag.	T1595.002 Vulnerability Scanning
AlertDesc	string	The description of the alert.	The account you logged in this time is not in the legal account category defined by you. Please confirm the legality of the login behavior。
OnlineStatus	string	The status of the alert data. Valid values: test: business test online: published	test
EventName	string	The name of the alert. This value corresponds to the name of the custom rule.	waf_scan
Level	string	The threat level. Valid values: serious: high suspicious: medium remind: low	remind
EventType	string	The threat type. This parameter is equivalent to the alert type.	WEBSHELL
AlertDetail	string	The details of the alert, in JSON format.	{"main_user_id": "165295629792****";"log_uuid_count": "99";"attack_ip": "218.92.XX.XX"}
LogTime	string	The time when the alert was recorded.	2023-01-06 16:37:29
VerifyType	string	The result of verifying the alert based on the alert template. true: The verification is passed. false: The verification failed.	true

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,
      "VerifiedCount": 30
    },
    "ResponseData": [
      {
        "Uuid": "sas_71e24437d2797ce8fc59692905a4****",
        "MainUserId": "127608589417****",
        "SubUserId": "176555323***",
        "LogType": "ALERT_ACTIVITY",
        "LogSource": "cloud_siem_aegis_sas_alert",
        "AlertSrcProd": "sas",
        "AlertSrcProdModule": "waf",
        "AttCk": "T1595.002 Vulnerability Scanning",
        "AlertDesc": "The account you logged in this time is not in the legal account category defined by you. Please confirm the legality of the login behavior。",
        "OnlineStatus": "test",
        "EventName": "waf_scan",
        "Level": "remind",
        "EventType": "WEBSHELL",
        "AlertDetail": "{\"main_user_id\": \"165295629792****\";\"log_uuid_count\": \"99\";\"attack_ip\": \"218.92.XX.XX\"}",
        "LogTime": "2023-01-06 16:37:29",
        "VerifyType": "true"
      }
    ]
  }
}

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.