DescribeSoarTaskAndActions - 获取剧本的组件执行记录

用于获取剧本的一次运行过程中,组件的执行记录列表。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:DescribeSoarTaskAndActions

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RequestUuid

string

剧本任务的 UUID。

1077f2f9-25e8-42d9-bfdf-1528e1313f6d

Lang

string

请求和接收消息的语言类型。

  • zh(默认):中文

  • en:英文

zh

PageNumber

integer

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

1

PageSize

integer

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

说明

建议 PageSize 取值不要为空。

10

QueryValue

string

剧本输入参数。

input

QueryType

string

任务触发类型,取值:

  • stream:流式触发。

  • debug:调试触发。

  • manual:人工触发。

  • timer:定时触发。

  • SubInvoke:子流程触发。

debug

返回参数

名称

类型

描述

示例值

object

返回信息。

RequestId

string

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

18017A93-3D5D-503A-8308-914543F1CBA3

Details

object

任务执行详情。

TriggerType

string

触发类型,取值:

  • debug:剧本调试的任务。

  • manual:手动触发的任务。

  • siem:事件触发的任务。

siem

TaskName

string

剧本任务的名称,同剧本的 UUID。

92af3c79-1754-4646-9366-9ddbd1e45536

StartTime

integer

剧本运行的开始时间,格式:13 位的时间戳。

1699868848645

EndTime

integer

剧本运行的结束时间,格式:13 位的时间戳。

1699868848767

Status

string

剧本执行的任务状态,取值为:

  • success:表示执行成功

  • fail:表示执行失败

  • running:表示正在运行

success

RequestUuid

string

剧本任务的请求 ID,每次任务运行的唯一 ID。

17f75844-75cc-4174-86da-cec07a690142

TriggerUser

string

触发剧本任务的阿里云账号 ID。

127xxxx4392

ErrorMsg

string

剧本任务的错误信息,任务成功时,该字段为空。

stime not match

RawEventReq

string

剧本任务的请求参数。

{ "input1": "xx.xx.xx.xx", "input2": "7d" }

Actions

array<object>

剧本执行的组件动作列表。

object

剧本执行的组件动作详情。

Component

string

组件的名称。

DataFormat

Action

string

组件的动作名称。

formatdata

StartTime

integer

组件运行的开始时间,格式:13 位的时间戳。

1699868848731

EndTime

integer

剧本运行的结束时间,格式:13 位的时间戳。

1699868848766

Status

string

组件的运行结果,取值为:

  • success:表示执行成功。

  • fail:表示执行失败。

success

ActionUuid

string

组件动作执行记录的 UUID。

091be399-a937-4276-af78-xxxxxxxx

AssetName

string

组件使用的资产名称。

SLS Asset

NodeName

string

组件的自定义节点名称。

DataFormat_1

TaskFlowMd5

string

运行剧本配置的 MD5 值。

ed127287-6699-4e4d-b986-9f770879xxx

ActionLogNum

integer

动作日志总数量。

5

Page

object

页面显示的信息。

TotalCount

string

查询到的信息总数量。

20

PageNumber

string

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

1

PageSize

string

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

10

示例

正常返回示例

JSON格式

{
  "RequestId": "18017A93-3D5D-503A-8308-914543F1CBA3",
  "Details": {
    "TriggerType": "siem",
    "TaskName": "92af3c79-1754-4646-9366-9ddbd1e45536",
    "StartTime": 1699868848645,
    "EndTime": 1699868848767,
    "Status": "success",
    "RequestUuid": "17f75844-75cc-4174-86da-cec07a690142",
    "TriggerUser": "127xxxx4392",
    "ErrorMsg": "stime not match",
    "RawEventReq": "{\n    \"input1\": \"xx.xx.xx.xx\",\n    \"input2\": \"7d\"\n}",
    "Actions": [
      {
        "Component": "DataFormat",
        "Action": "formatdata",
        "StartTime": 1699868848731,
        "EndTime": 1699868848766,
        "Status": "success",
        "ActionUuid": "091be399-a937-4276-af78-xxxxxxxx",
        "AssetName": "SLS Asset",
        "NodeName": "DataFormat_1"
      }
    ],
    "TaskFlowMd5": "ed127287-6699-4e4d-b986-9f770879xxx",
    "ActionLogNum": 5
  },
  "Page": {
    "TotalCount": "20",
    "PageNumber": "1",
    "PageSize": "10"
  }
}

错误码

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

变更历史

更多信息,参考变更详情