ListAutomateResponseConfigs - Security Center - Alibaba Cloud Documentation Center

Retrieves a list of automated response 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:ListAutomateResponseConfigs

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	No	The ID of the automated response rule.	123
SubUserId	integer	No	The ID of the user who created the rule.	17108579417****
PlaybookUuid	string	No	The unique identifier of the playbook.	system_aliyun_aegis_kill_quara_book
RuleName	string	No	The name of the automated response rule.	cfw kill quara book
AutoResponseType	string	No	The type of the automated response. Valid values: event alert	event
ActionType	string	No	The type of the handling action. Valid values: doPlaybook: executes a playbook. changeEventStatus: changes the status of an event. changeThreatLevel: changes the threat level of an event.	doPlaybook
Status	integer	No	The status of the rule. Valid values: 0: disabled 100: enabled	0
CurrentPage	integer	Yes	The page number. The value must be 1 or greater.	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 belong to the enterprise.	1
RoleFor	integer	No	The ID of the member to which the administrator switches.	113091674488****
RegionId	string	No	The region of the Data Management center. Select a region based on the region where your assets are located. Valid values: cn-hangzhou: your assets are in the Chinese mainland or China (Hong Kong). ap-southeast-1: your assets are in a region outside China.	cn-hangzhou
ResponseRuleType	string	No	The type of the response rule. preset: predefined custom: custom	custom

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 request 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 of the returned page.	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 automated response rule.	123
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 associated with the rule.	127608589417****
SubUserId	integer	The ID of the user who created the rule.	17108579417****
RuleName	string	The name of the automated response rule.	cfw kill quara book
AutoResponseType	string	The type of the automated response. Valid values: event alert	event
ExecutionCondition	string	The trigger condition of the automated response rule. The value is in the JSON format.	[{"left":{"value":"alert_name"},"operator":"containsString","right":{"value":"webshell_online"}}]
ActionType	string	The handling action. Multiple values are separated by commas. Valid values: doPlaybook: executes a playbook. changeEventStatus: changes the status of an event. changeThreatLevel: changes the threat level of an event.	doPlaybook,changeEventStatus
ActionConfig	string	The action configuration of the automated response rule. The value is a JSON array.	[ { "actionType": "doPlaybook", "playbookName": "WafBlockIP", "playbookUuid": "bdad6220-6584-41b2-9704-fc6584568758" } ]
Status	integer	The status of the rule. Valid values: 0: disabled 100: enabled	0
DataType	integer	The data type of the condition field in the automated response rule.	varchar
ResponseRuleType	string	The type of the response rule. preset: predefined custom: custom	custom

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": 123,
        "GmtCreate": "2021-01-06 16:37:29",
        "GmtModified": "2021-01-06 16:37:29",
        "Aliuid": 0,
        "SubUserId": 0,
        "RuleName": "cfw kill quara book",
        "AutoResponseType": "event",
        "ExecutionCondition": "[{\"left\":{\"value\":\"alert_name\"},\"operator\":\"containsString\",\"right\":{\"value\":\"webshell_online\"}}]",
        "ActionType": "doPlaybook,changeEventStatus",
        "ActionConfig": "[\n      {\n            \"actionType\": \"doPlaybook\",\n            \"playbookName\": \"WafBlockIP\",\n            \"playbookUuid\": \"bdad6220-6584-41b2-9704-fc6584568758\"\n      }\n]",
        "Status": 0,
        "DataType": 0,
        "ResponseRuleType": "custom"
      }
    ]
  }
}

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.