DescribeWhiteRuleList - Security Center - Alibaba Cloud Documentation Center

Queries the rules in the alert whitelist.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AlertType	string	No	The alert type.	scan
AlertName	string	No	The alert name.	Try SNMP weak password
IncidentUuid	string	No	The universally unique identifier (UUID) of the event.	85ea4241-798f-4684-a876-65d4f0c3****
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 that are managed by the administrator account.	1
RoleFor	integer	No	The ID of the member. This parameter is used in a multi-account management scenario. An administrator can specify this parameter to query the data 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 are located. Valid values: cn-hangzhou: Your assets are deployed in the Chinese mainland or in the China (Hong Kong) region. ap-southeast-1: Your assets are deployed in regions outside the Chinese mainland.	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 status code of the request.	200
Message	string	The returned message.	success
RequestId	string	The request ID.	9AAA9ED9-78F4-5021-86DC-D51C7511****
Data	object	The return value.	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
ResponseData	array<object>	The detailed data.
	object
Id	integer	The unique ID of the whitelist 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
Aliuid	integer	The ID of the Alibaba Cloud account that is used to purchase Threat Analysis.	127608589417****
SubAliuid	integer	The ID of the Alibaba Cloud account that is used to create the rule.	176555323***
AlertType	string	The alert type.	scan
AlertTypeId	string	The ID of the alert type.	scan
AlertName	string	The alert name.	Try SNMP weak password
AlertNameId	string	The ID of the alert name.	Try SNMP weak password
Status	integer	The status of the rule. Valid values: 1: enabled 0: disabled	1
IncidentUuid	string	The UUID of the event.	85ea4241-798f-4684-a876-65d4f0c3****
AlertUuid	string	The UUID of the alert.	sas_71e24437d2797ce8fc59692905a4****
Expression	object	The rule conditions, which are in the JSON array format.	[{"conditions":[{"isNot":false,"itemId":0,"left":{"value":"host_uuid.host_name"},"operator":"containsString","right":{"value":"Cloud-MCH"}}]}]
Logic	string	The logical relation for the conditions.	(1&2)\|(3&4)
Conditions	array<object>	The array of rule conditions.
	object	The array of rule conditions.
ItemId	integer	The condition ID.	1
Operator	string	The operator. Valid values: `=`: equals `<>`: does not equal `in`: includes `not in`: does not include `REGEXP`: matches a regular expression `NOT REGEXP`: does not match a regular expression	REGEXP
IsNot	boolean	Indicates whether to negate the result. Valid values: true: The result is negated. false: The result is not negated.	false
Left	object	The left operand of the condition.
Value	string	The variable of the left operand.	ip
IsVar	boolean	Indicates whether the left operand is a variable. Valid values: true: variable false: constant	true
Type	string	Specifies whether the value is a constant. Valid values: true: The value is a constant. false: The value is not a constant.	false
Modifier	string	The remarks.	length
ModifierParam	object	The key-value pair for the remarks.
	any	The key-value pair for the remarks.	{"tage":"description"}
Right	object	The right operand.
Value	string	The value of the right operand.	12345
IsVar	boolean	Specifies whether the right operand is a constant or a runtime variable. A runtime variable obtains a value from the runtime context. Valid values: true: runtime variable false: constant	false
Type	string	The data type.	String
Modifier	string	The remarks.	length
ModifierParam	object	The key-value pair for the remarks.
	any	The key-value pair for the remarks.	{"tage":"description"}

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,
        "SubAliuid": 0,
        "AlertType": "scan",
        "AlertTypeId": "scan",
        "AlertName": "Try SNMP weak password",
        "AlertNameId": "Try SNMP weak password",
        "Status": 1,
        "IncidentUuid": "85ea4241-798f-4684-a876-65d4f0c3****",
        "AlertUuid": "sas_71e24437d2797ce8fc59692905a4****",
        "Expression": {
          "Logic": "(1&2)|(3&4)",
          "Conditions": [
            {
              "ItemId": 1,
              "Operator": "REGEXP",
              "IsNot": false,
              "Left": {
                "Value": "ip",
                "IsVar": true,
                "Type": "false",
                "Modifier": "length",
                "ModifierParam": {
                  "key": "{\"tage\":\"description\"}"
                }
              },
              "Right": {
                "Value": "12345",
                "IsVar": false,
                "Type": "String",
                "Modifier": "length",
                "ModifierParam": {
                  "key": "{\"tage\":\"description\"}"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

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.