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

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeSoarTaskAndActionsget
*全部资源
*

请求参数

名称类型必填描述示例值
RequestUuidstring

剧本任务的 UUID。

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

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

  • zh(默认):中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

返回信息。

RequestIdstring

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

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

任务执行详情。

TriggerTypestring

触发类型,取值:

  • debug:剧本调试的任务。
  • manual:手动触发的任务。
  • siem:事件触发的任务。
siem
TaskNamestring

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

92af3c79-1754-4646-9366-9ddbd1e45536
StartTimelong

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

1699868848645
EndTimelong

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

1699868848767
Statusstring

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

  • success:表示执行成功
  • fail:表示执行失败
  • running:表示正在运行
success
RequestUuidstring

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

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

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

127xxxx4392
ErrorMsgstring

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

stime not match
RawEventReqstring

剧本任务的请求参数。

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

剧本调试任务的标志为,当任务为调试任务时,值为 DEBUG,其余为空。

DEBUG
ResultMessagestring

剧本的返回信息,由用户在剧本中自己定义。

deubug playbook finished
TaskTenantIdstring

剧本任务所属的阿里云账户 ID。

127xxxx4392
Actionsarray<object>

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

Actionobject

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

Componentstring

组件的名称。

DataFormat
Actionstring

组件的动作名称。

formatdata
StartTimelong

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

1699868848731
EndTimelong

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

1699868848766
Statusstring

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

  • success:表示执行成功。
  • fail:表示执行失败。
success
RequestUuidstring

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

8dac16c6-7411-4116-8d70-xxxxxxx
TriggerUserstring

执行剧本任务的阿里云账户 ID。

127xxxx4392
TaskNamestring

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

ed127287-6699-4e4d-b986-xxxxxxx
TaskStatusstring

触发组件动作的执行状态。

说明 该参数已不启用,只返回空值。
NULL
ActionUuidstring

组件动作执行记录的 UUID。

091be399-a937-4276-af78-xxxxxxxx
AssetNamestring

组件使用的资产名称。

SLS Asset
NodeNamestring

组件的自定义节点名称。

DataFormat_1
TaskFlowMd5string

运行剧本配置的 MD5 值。

ed127287-6699-4e4d-b986-9f770879xxx

示例

正常返回示例

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}",
    "ResultLevel": "DEBUG",
    "ResultMessage": "deubug playbook finished",
    "TaskTenantId": "127xxxx4392",
    "Actions": [
      {
        "Component": "DataFormat",
        "Action": "formatdata",
        "StartTime": 1699868848731,
        "EndTime": 1699868848766,
        "Status": "success",
        "RequestUuid": "8dac16c6-7411-4116-8d70-xxxxxxx",
        "TriggerUser": "127xxxx4392\n",
        "TaskName": "ed127287-6699-4e4d-b986-xxxxxxx",
        "TaskStatus": "NULL",
        "ActionUuid": "091be399-a937-4276-af78-xxxxxxxx",
        "AssetName": "SLS Asset",
        "NodeName": "DataFormat_1"
      }
    ],
    "TaskFlowMd5": "ed127287-6699-4e4d-b986-9f770879xxx"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史