ListAutomateResponseConfigs - 获取自动化响应规则列表

获取自动化响应规则列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:ListAutomateResponseConfigs

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Id

integer

自动化响应配置规则 ID。

123

SubUserId

integer

规则创建用户 ID。

17108579417****

PlaybookUuid

string

剧本唯一标识。

system_aliyun_aegis_kill_quara_book

RuleName

string

自动化响应配置规则名称。

cfw kill quara book

AutoResponseType

string

自动化响应类型。取值:

  • event:事件

  • alert:告警

event

ActionType

string

处置动作类型。取值:

  • doPlaybook:执行剧本

  • changeEventStatus:更改事件状态

  • changeThreatLevel:更改事件威胁等级

doPlaybook

Status

integer

规则状态。取值:

  • 0:未启用

  • 100:启用

0

CurrentPage

integer

列表当前页号,大于等于 1。

1

PageSize

integer

列表每页条数,最大不超过 100。

10

RoleType

integer

视图类型。

  • 0:当前阿里云账号视图。

  • 1:企业下所有账号的视图。

1

RoleFor

integer

管理员切换成其他成员视角的用户 ID。

113091674488****

RegionId

string

威胁分析的数据管理中心所在地。您需要根据资产所在地域,选择管理中心所在地。取值:

  • cn-hangzhou:资产属于中国内地与中国香港

  • ap-southeast-1:资产属于海外地域

cn-hangzhou

ResponseRuleType

string

响应规则类型。

  • preset:预定义

  • custom:自定义

custom

返回参数

名称

类型

描述

示例值

object

PageResponse<List>

Success

boolean

请求是否成功。取值:

  • true:成功

  • false:失败

true

Code

integer

请求状态码。

200

Message

string

请求返回消息。

success

RequestId

string

请求 ID。

9AAA9ED9-78F4-5021-86DC-D51C7511****

Data

object

请求返回值。

123456

PageInfo

object

分页记录。

CurrentPage

integer

列表当前页号。

1

PageSize

integer

每页返回记录数。

10

TotalCount

integer

记录总数。

100

ResponseData

array<object>

详细数据。

object

Id

integer

自动化响应配置规则 ID。

123

GmtCreate

string

创建时间。

2021-01-06 16:37:29

GmtModified

string

修改时间。

2021-01-06 16:37:29

Aliuid

integer

规则关联 SIEM 主账号 ID。

127608589417****

SubUserId

integer

规则创建用户 ID。

17108579417****

RuleName

string

自动化响应配置规则名称。

cfw kill quara book

AutoResponseType

string

自动化响应类型。取值:

  • event:事件

  • alert:告警

event

ExecutionCondition

string

自动化响应规则触发条件,JSON 格式。

[{"left":{"value":"alert_name"},"operator":"containsString","right":{"value":"webshell_online"}}]

ActionType

string

处置动作类型,多个值以逗号分隔。取值:

  • doPlaybook:执行剧本

  • changeEventStatus:更改事件状态

  • changeThreatLevel:更改事件威胁等级

doPlaybook,changeEventStatus

ActionConfig

string

自动化响应规则动作配置,JSON 数组格式。

[ { "actionType": "doPlaybook", "playbookName": "WafBlockIP", "playbookUuid": "bdad6220-6584-41b2-9704-fc6584568758" } ]

Status

integer

规则状态。取值:

  • 0:未启用

  • 100:启用

0

DataType

integer

自动化响应规则条件字段数据类型。

varchar

ResponseRuleType

string

响应规则类型。

  • preset:预定义

  • custom:自定义

custom

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

500 InternalError The request processing has failed due to some unknown error. 服务发生某些未知错误,请稍后再试

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情