文档

DescribeSoarRecords - 获取剧本执行记录

更新时间:

用于获取剧本的执行记录列表。

调试

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

授权信息

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

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

请求参数

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

剧本的 UUID。

说明 调用 DescribePlaybooks 接口可以获取该参数。
8f55e76d-b5d5-4720-9cd7-xxxxx
TaskflowMd5string

剧本配置的 MD5 值。

be0a4ef084dd174abe478df52xxxxx
StartMillislong

任务运行的开始时间,格式:13 位的时间戳。

1683526284584
EndMillislong

任务运行的结束时间,格式:13 位的时间戳。

1683772744953
Langstring

设置请求和接收消息的语言类型,默认为 zh。取值:

  • zh:中文
  • en:英文
zh
TriggerUserstring

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

127xxxx4392
TaskStatusstring

任务的运行状态,取值:

  • success:成功任务。
  • failed:失败任务。
  • inprogress:运行中任务
inprogress
PageNumberinteger

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

1
PageSizeinteger

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

说明 建议 PageSize 取值不要为空。
10

返回参数

名称类型描述示例值
object

返回信息。

RequestIdstring

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

601C2DAC-6A67-5237-BEE8-5BF1CEE96296
SoarExecuteRecordsobject []

执行记录结果集。

TriggerTypestring

剧本任务的类型,取值:

  • debug:表示调试任务。
  • manual:表示手动任务。
  • siem:表示事件或告警触发的任务。
debug
TaskNamestring

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

82848ebc-eaff-4791-acd4-xxxxx
StartTimelong

任务运行的开始时间,格式:13 位的时间戳。

1675823338433
EndTimelong

组件运行的结束时间,格式:13 位的时间戳。

1686294686000
Statusstring

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

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

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

ba1ec480-aa90-4bb6-a1a7-9e311ae79321
TriggerUserstring

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

127xxxx4392
ErrorMsgstring

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

stime not match
RawEventReqstring

剧本任务的请求参数。

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

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

Playbook finish
TaskTypestring

剧本任务的类型,取值:

  • general:表示普通剧本任务。
  • standard:表示组件运行任务。
standard
TaskflowMd5string

剧本配置的 MD5 值。

dea65a3db87fb9bd84bbxxxxx
Pageobject

页面显示的信息。

TotalCountinteger

查询到的信息总数量。

22
PageNumberinteger

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

1
PageSizeinteger

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

10

示例

正常返回示例

JSON格式

{
  "RequestId": "601C2DAC-6A67-5237-BEE8-5BF1CEE96296",
  "SoarExecuteRecords": [
    {
      "TriggerType": "debug",
      "TaskName": "82848ebc-eaff-4791-acd4-xxxxx",
      "StartTime": 1675823338433,
      "EndTime": 1686294686000,
      "Status": "success",
      "RequestUuid": "ba1ec480-aa90-4bb6-a1a7-9e311ae79321",
      "TriggerUser": "127xxxx4392",
      "ErrorMsg": "stime not match",
      "RawEventReq": "{\n    \"input1\": \"xx.xx.xx.xx\",\n    \"input2\": \"7d\"\n}",
      "ResultMessage": "Playbook finish",
      "TaskType": "standard",
      "TaskflowMd5": "dea65a3db87fb9bd84bbxxxxx"
    }
  ],
  "Page": {
    "TotalCount": 22,
    "PageNumber": 1,
    "PageSize": 10
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈