DescribeSoarTaskAndActions - Security Center - Alibaba Cloud Documentation Center

Retrieves the component execution records for a single playbook run.

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:DescribeSoarTaskAndActions

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RequestUuid	string	No	The UUID of the playbook task.	1077f2f9-25e8-42d9-bfdf-1528e1313f6d
Lang	string	No	The language of the request and response. Valid values: zh (default): Chinese en: English	zh
PageNumber	string	No	The page number. Default value: 1.	1
PageSize	string	No	The number of entries to return on each page. The maximum value is 20. If you do not specify this parameter, 10 entries are returned. Note Specify a value for this parameter.	10
QueryValue	string	No	The input parameter of the playbook.	input
QueryType	string	No	The trigger type of the task. Valid values: stream: The task is triggered by a data stream. debug: The task is triggered by a debugging process. manual: The task is triggered manually. timer: The task is triggered by a timer. SubInvoke: The task is triggered by a child flow.	debug

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	18017A93-3D5D-503A-8308-914543F1CBA3
Details	object	The details of the task execution.
TriggerType	string	The trigger type. Valid values: debug: A task for debugging a playbook. manual: A manually triggered task. siem: An event-triggered task.	siem
TaskName	string	The name of the playbook task. This is the same as the playbook UUID.	92af3c79-1754-4646-9366-9ddbd1e45536
StartTime	integer	The start time of the playbook run. This is a 13-digit timestamp.	1699868848645
EndTime	integer	The end time of the playbook run. This is a 13-digit timestamp.	1699868848767
Status	string	The status of the playbook task. Valid values: success: The task was successful. fail: The task failed. running: The task is running.	success
RequestUuid	string	The request ID of the playbook task. This is the unique ID for each task run.	17f75844-75cc-4174-86da-cec07a690142
TriggerUser	string	The ID of the Alibaba Cloud account that triggered the playbook task.	127xxxx4392
ErrorMsg	string	The error message for the playbook task. This field 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" }
Actions	array<object>	The list of component actions executed in the playbook.
	object	The details of a component action executed in the playbook.
Component	string	The name of the component.	DataFormat
Action	string	The name of the component action.	formatdata
StartTime	integer	The start time of the component run. This is a 13-digit timestamp.	1699868848731
EndTime	integer	The end time of the component run. This is a 13-digit timestamp.	1699868848766
Status	string	The result of the component run. Valid values: success: The run was successful. fail: The run failed.	success
ActionUuid	string	The UUID of the component action execution record.	091be399-a937-4276-af78-xxxxxxxx
AssetName	string	The name of the asset used by the component.	SLS Asset
NodeName	string	The custom node name of the component.	DataFormat_1
TaskFlowMd5	string	The MD5 value of the playbook configuration that was run.	ed127287-6699-4e4d-b986-9f770879xxx
ActionLogNum	integer	The total number of action logs.	5
Page	object	The pagination information.
TotalCount	string	The total number of entries returned.	20
PageNumber	string	The page number of the returned page.	1
PageSize	string	The number of entries returned per page.	10

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.