DescribeSoarRecords - 获取剧本执行记录_云安全中心(Security Center)-阿里云帮助中心

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:DescribeSoarRecords

get

*Playbook

acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}

无

请求参数

名称	类型	必填	描述	示例值
PlaybookUuid	string	否	剧本的 UUID。说明调用 DescribePlaybooks 接口可以获取该参数。	8f55e76d-b5d5-4720-9cd7-xxxxx
TaskflowMd5	string	否	剧本配置的 MD5 值。	be0a4ef084dd174abe478df52xxxxx
StartMillis	integer	否	任务运行的开始时间，格式：13 位的时间戳。	1683526284584
EndMillis	integer	否	任务运行的结束时间，格式：13 位的时间戳。	1683772744953
Lang	string	否	设置请求和接收消息的语言类型，默认为 zh。取值： zh：中文 en：英文	zh
TriggerUser	string	否	执行剧本任务的阿里云账户 ID。	127xxxx4392
TaskStatus	string	否	任务的运行状态，取值： success：成功任务。 failed：失败任务。 inprogress：运行中任务。	inprogress
PageNumber	integer	否	设置从返回结果的第几页开始显示查询结果。默认值为 1，表示从第 1 页开始显示。	1
PageSize	integer	否	指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为 20 条，PageSize 参数值为空时，将默认返回 10 条数据。说明建议 PageSize 取值不要为空。	10
RequestUuid	string	否	剧本任务执行的 UUID。说明调用 DescribeSoarRecords 接口可以获取该参数。	6d412cfa-0905-4567-8a83-xxxxxx
TriggerType	string	否	任务触发类型，取值： stream：流式触发。 debug：调试触发。 manual：人工触发。 timer：定时触发。 SubInvoke：子流程触发。 siem：siem 产品触发。	debug
QueryValue	string	否	剧本输入参数。	input
CompletedBeginTime	integer	否	任务完成的开始时间，格式：13 位的时间戳。	1755676363777
CompletedEndTime	integer	否	任务完成的结束时间，格式：13 位的时间戳。	1683526284584

返回参数

名称	类型	描述	示例值
	object	返回信息。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	601C2DAC-6A67-5237-BEE8-5BF1CEE9*****
SoarExecuteRecords	array<object>	执行记录结果集。
	object	执行记录详情。
TriggerType	string	剧本任务的类型，取值： debug：表示调试任务。 manual：表示手动任务。 siem：表示事件或告警触发的任务。	debug
TaskName	string	剧本任务的名称，同剧本的 UUID。	82848ebc-eaff-4791-acd4-xxxxx
StartTime	integer	任务运行的开始时间，格式：13 位的时间戳。	1675823338433
EndTime	integer	组件运行的结束时间，格式：13 位的时间戳。	1686294686000
Status	string	剧本执行的任务状态，取值为： success：表示执行成功。 fail：表示执行失败。 running：表示正在运行	success
RequestUuid	string	剧本任务的请求 ID，每次任务运行的唯一 ID。	ba1ec480-aa90-4bb6-a1a7-9e311ae*****
TriggerUser	string	执行剧本任务的阿里云账户 ID。	127xxxx4392
ErrorMsg	string	剧本任务的错误信息，任务成功时，该字段为空。	stime not match
RawEventReq	string	剧本任务的请求参数。	{ "input1": "xx.xx.xx.xx", "input2": "7d" }
TaskflowMd5	string	剧本配置的 MD5 值。	dea65a3db87fb9bd84bbxxxxx
OutputList	array<object>	剧本的输出信息。
	object	JSONArray
Content	string	输出内容。	{"msg":"process has been killed","code":"KillSuccess","status":"success"}
NodeName	string	输出信息的节点名称。	TriggerPlaybook_4
ActionUuid	string	节点 UUID。	4e78d665-2366-4485-8fbc-048a8d41a2c3-25****
Page	object	页面显示的信息。
TotalCount	integer	查询到的信息总数量。	22
PageNumber	integer	分页查询时，当前页的页码。	1
PageSize	integer	分页查询时，每页显示的条目数量。	10

示例

正常返回示例

JSON格式

{
  "RequestId": "601C2DAC-6A67-5237-BEE8-5BF1CEE9*****",
  "SoarExecuteRecords": [
    {
      "TriggerType": "debug",
      "TaskName": "82848ebc-eaff-4791-acd4-xxxxx",
      "StartTime": 1675823338433,
      "EndTime": 1686294686000,
      "Status": "success",
      "RequestUuid": "ba1ec480-aa90-4bb6-a1a7-9e311ae*****",
      "TriggerUser": "127xxxx4392",
      "ErrorMsg": "stime not match",
      "RawEventReq": "{\n    \"input1\": \"xx.xx.xx.xx\",\n    \"input2\": \"7d\"\n}",
      "TaskflowMd5": "dea65a3db87fb9bd84bbxxxxx",
      "OutputList": [
        {
          "Content": " {\"msg\":\"process has been killed\",\"code\":\"KillSuccess\",\"status\":\"success\"}",
          "NodeName": "TriggerPlaybook_4",
          "ActionUuid": "4e78d665-2366-4485-8fbc-048a8d41a2c3-25****"
        }
      ]
    }
  ],
  "Page": {
    "TotalCount": 22,
    "PageNumber": 1,
    "PageSize": 10
  }
}

错误码

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

变更历史

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