DescribeSoarRecords - Security Center - Alibaba Cloud Documentation Center

Queries the execution records for a playbook.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribeSoarRecords

get

*Playbook

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

None

Request parameters

Parameter	Type	Required	Description	Example
PlaybookUuid	string	No	The UUID of the playbook. Note For more information, see DescribePlaybooks.	8f55e76d-b5d5-4720-9cd7-xxxxx
TaskflowMd5	string	No	The MD5 value of the playbook configuration.	be0a4ef084dd174abe478df52xxxxx
StartMillis	integer	No	The start time of the task run. The value is a 13-digit UNIX timestamp.	1683526284584
EndMillis	integer	No	The end time of the task run. The value is a 13-digit UNIX timestamp.	1683772744953
Lang	string	No	The language of the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh
TriggerUser	string	No	The ID of the Alibaba Cloud account that runs the playbook task.	127xxxx4392
TaskStatus	string	No	The status of the task run. Valid values: success: The task is successful. failed: The task failed. inprogress: The task is in progress.	inprogress
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 10 entries are returned on each page. Note Specify a value for PageSize.	10
RequestUuid	string	No	The UUID of the playbook task execution. Note For more information, see DescribeSoarRecords.	6d412cfa-0905-4567-8a83-xxxxxx
TriggerType	string	No	The trigger type of the task. Valid values: stream: stream debug: test manual: manual timer: scheduled SubInvoke: child flow siem: triggered by a SIEM product	debug
QueryValue	string	No	The input parameter of the playbook.	input
CompletedBeginTime	integer	No	The start time when the task was completed. The value is a 13-digit UNIX timestamp.	1755676363777
CompletedEndTime	integer	No	The end time when the task was completed. The value is a 13-digit UNIX timestamp.	1683526284584

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The unique request ID, generated by Alibaba Cloud. Use this ID to troubleshoot issues.	601C2DAC-6A67-5237-BEE8-5BF1CEE9*****
SoarExecuteRecords	array<object>	The execution records.
	array<object>	The details of an execution record.
TriggerType	string	The type of the playbook task. Valid values: debug: a test task manual: a one-time task siem: a task that is triggered by an event or alert	debug
TaskName	string	The name of the playbook task. The value is the UUID of the playbook.	82848ebc-eaff-4791-acd4-xxxxx
StartTime	integer	The start time of the task run. The value is a 13-digit UNIX timestamp.	1675823338433
EndTime	integer	The end time of the component run. The value is a 13-digit UNIX timestamp.	1686294686000
Status	string	The status of the playbook task. Valid values: success: The execution is successful. fail: The execution failed. running: The execution is in progress.	success
RequestUuid	string	The request ID of the playbook task. The ID is unique for each task run.	ba1ec480-aa90-4bb6-a1a7-9e311ae*****
TriggerUser	string	The ID of the Alibaba Cloud account that runs the playbook task.	127xxxx4392
ErrorMsg	string	The error message of the playbook task. This parameter is empty if the task is successful.	stime not match
RawEventReq	string	The request parameters of the playbook task.	{ "input1": "xx.xx.xx.xx", "input2": "7d" }
TaskflowMd5	string	The MD5 value of the playbook configuration.	dea65a3db87fb9bd84bbxxxxx
OutputList	array<object>	The output information of the playbook.
	object	JSONArray
Content	string	The output content.	{"msg":"process has been killed","code":"KillSuccess","status":"success"}
NodeName	string	The name of the node that generates the output.	TriggerPlaybook_4
ActionUuid	string	The UUID of the node.	4e78d665-2366-4485-8fbc-048a8d41a2c3-25****
Page	object	The pagination information.
TotalCount	integer	The total number of entries returned.	22
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned on each page.	10

Examples

Success response

JSON format

{
  "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
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.