AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云安全中心 开发参考 API参考（响应编排） API目录 处置任务 DescribeProcessTasks - 获取处置任务列表

DescribeProcessTasks - 获取处置任务列表

更新时间：
产品详情
我的收藏

用户在使用响应编排的功能进行事件处置时，处置中心会生成相应的处置任务，该接口用于获取处置任务的列表信息。

接口说明

请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和价格。

调试

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

调试

授权信息

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

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

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:DescribeProcessTasks

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
ProcessStrategyUuid

string

否

处置策略的 UUID。

说明

调用 ListDisposeStrategy 接口可以获取该参数。

92af3c79-1754-4646-9366-9ddbd1e45536_****
EntityName

string

否

处置的实体的名称。

127.0.0.1
EntityType

string

否

处置的实体类型，取值：

  • ip：表示 IP 类型实体

  • file：表示文件类型实体

  • process：表示进程类型实体

ip
SceneCode

string

否

处置任务的场景 CODE。

说明

调用 DescribeEnumItems 接口可以获取该参数，接口的入参 EnumType 为 process。

event_xxx_whole_process
TaskStatus

string

否

处置任务的状态列表，为数据字符串的格式，取值：

  • 11：表示处置中

  • 21：表示封禁中

  • 22：表示隔离中

  • 23：已结束

  • 24：已加白

  • 20：成功

  • 90：失败

  • 91：解封失败

  • 92：解除隔离失败

["11","21"]
Scope

string

否

处置的阿里云账户 ID。

125xxxxx9870
Source

string

否

处置任务的触发来源，为数组字符串格式，取值：

  • system：手动处置事件触发

  • custom：自动响应规则，事件触发

  • custom_alert：自动响应规则，告警触发

  • soar-manual：SOAR 手动调用剧本触发

  • soar-mdr：由安全管家服务触发

["system"]
ProcessActionStart

integer

否

处置时间的查询开始时间，格式：13 位的时间戳。

1700031183572
ProcessActionEnd

integer

否

处置时间的查询结束时间，格式：13 位的时间戳。

1700031183572
ProcessRemoveStart

integer

否

解封时间的查询开始时间，格式：13 位的时间戳。

1700031183572
ProcessRemoveEnd

integer

否

解封时间的查询结束时间，格式：13 位的时间戳。

1700031183572
ParamContent

string

否

模糊匹配，会查询实体、处置场景、处置参数字段。

12.x.x.x
PageSize

integer

否

指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为 20 条，PageSize 参数值为空时，将默认返回 10 条数据。

说明

建议 PageSize 取值不要为空。

10
PageNumber

integer

否

设置从返回结果的第几页开始显示查询结果。默认值为 1，表示从第 1 页开始显示。

1
YunCode

string

否

处置任务关联的云产品，为数据字符串格式，取值：

  • WAF：表示 Web 应用防火墙

  • CFW：表示云防火墙

  • Aegis：表示云安全中心

["WAF"]
TaskId

string

否

处置任务的唯一标识。

说明

用于查询某具体任务，参数可由接口的返回值中获取。

150xxxxxxxxx95066
OrderField

string

否

结果的排序字段。

说明

排序的字段，由接口的返回结果中获取。

gmtCreate
Direction

string

否

排序方向，取值：

  • desc：递减（默认）

  • asc：递增

desc
EntityUuid

string

否

实体 UUID。

69d189e2-ec17-4676-a2fe-02969234****

EventUuid

string

否

事件 UUID。

c1020ce1-d6a5-11e8-8298-00163e10****
TriggerSource

string

否

处置任务的触发来源，取值：

  • system：手动处置事件触发

  • custom：自动响应规则，事件触发

  • custom_alert：自动响应规则，告警触发

  • soar-manual：SOAR 手动调用剧本触发

  • soar-mdr：由安全管家服务触发

system
ReqUuid

string

否

剧本触发 ID。

b73d0b08-f1bd-4e8f-967a-8e2982c9****

返回参数

名称

类型

描述

示例值

object

返回信息。

RequestId

string

本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

E7698CFB-4E1C-5840-8EC9-691B86729E94
ProcessTasks

array<object>

处置任务列表。

object

处置任务详情。

TaskId

string

处置任务的唯一标识。

150xxxxxxxxx95066
Creator

string

提交处置任务的阿里云账户 ID。

123xxxx355
GmtCreateMillis

integer

处置任务的创建时间，格式：13 位的时间戳。

1700031183572
GmtModifiedMillis

integer

处置任务的修改时间，格式：13 位的时间戳。

1700031183572
YunCode

string

处置任务关联的云产品 CODE。

WAF
EntityName

string

处置的实体名称。

1.1.1.x
EntityType

string

处置的实体类型。

ip
TaskStatus

integer

处置任务的状态。

11
Scope

string

处置的阿里云账户 ID。

123xxxxx234
InputParams

string

处置任务的输入参数。

{"groupuuid":"c6a9b1df-f4ac-4078-bef4-99xxxxxx"}
SceneCode

string

处置任务的场景 CODE。

event_xxx_whole_process
SceneName

string

处置任务的场景名称。

waf_whole_process
ProcessTime

integer

处置任务的下发时间，格式：13 位的时间戳。

1700031183572
RemoveTime

integer

处置任务的解封时间，格式：13 位的时间戳。

1700031183572
ProcessStrategyUuid

string

关联的策略 ID。

92af3c79-1754-4646-9366-9ddbd1e45536_****
Source

string

处置任务的提交来源。

system
ErrCode

string

错误码。

sts_openapi.Info.DefenseSceneNotSupported
ErrMsg

string

错误信息。

ParamError : The parameters of your request are invalid
ErrTip

string

错误提示。

Verify that the input parameters of the components are correct
EntityUuid

string

实体 UUID。

69d189e2-ec17-4676-a2fe-02969234****

EventUuid

string

事件 UUID。

c1020ce1-d6a5-11e8-8298-00163e10****

ReqUuid

string

剧本执行记录 UUID。

93e5df20-3d03-42e1-b44b-58197c71****

TriggerSource

string

处置任务的触发来源，取值：

  • system：手动处置事件触发

  • custom：自动响应规则，事件触发

  • custom_alert：自动响应规则，告警触发

  • soar-manual：SOAR 手动调用剧本触发

  • soar-mdr：由安全管家服务触发

system
Page

object

页面显示的信息。

TotalCount

integer

查询到的信息总数量。

30
PageNumber

integer

分页查询时，当前页的页码。

1
PageSize

integer

分页查询时，每页显示的条目数量。

10

示例

正常返回示例

JSON格式

{
  "RequestId": "E7698CFB-4E1C-5840-8EC9-691B86729E94",
  "ProcessTasks": [
    {
      "TaskId": "150xxxxxxxxx95066",
      "Creator": "123xxxx355",
      "GmtCreateMillis": 1700031183572,
      "GmtModifiedMillis": 1700031183572,
      "YunCode": "WAF",
      "EntityName": "1.1.1.x",
      "EntityType": "ip",
      "TaskStatus": 11,
      "Scope": "123xxxxx234",
      "InputParams": "{\"groupuuid\":\"c6a9b1df-f4ac-4078-bef4-99xxxxxx\"}",
      "SceneCode": "event_xxx_whole_process",
      "SceneName": "waf_whole_process",
      "ProcessTime": 1700031183572,
      "RemoveTime": 1700031183572,
      "ProcessStrategyUuid": "92af3c79-1754-4646-9366-9ddbd1e45536_****",
      "Source": "system",
      "ErrCode": "sts_openapi.Info.DefenseSceneNotSupported",
      "ErrMsg": "ParamError : The parameters of your request are invalid",
      "ErrTip": "Verify that the input parameters of the components are correct",
      "EntityUuid": "69d189e2-ec17-4676-a2fe-02969234****\n",
      "EventUuid": "c1020ce1-d6a5-11e8-8298-00163e10****\n",
      "ReqUuid": "93e5df20-3d03-42e1-b44b-58197c71****\n",
      "TriggerSource": "system"
    }
  ],
  "Page": {
    "TotalCount": 30,
    "PageNumber": 1,
    "PageSize": 10
  }
}

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：DescribeProcessTaskCount - 通过实体UUID查询关联的处置任务数下一篇：TriggerProcessTask - 执行处置动作