SOAR Playbook Task Execution Details Overview - Security Center - Alibaba Cloud - Security Center

Operation description

Only the Enterprise and Flagship editions of Cloud Security Center support this operation.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RecordId	integer	Yes	The vulnerability ID specified when the policy task was created. Note You can call the DescribeVulList operation to query this ID.	14
PlaybookId	integer	Yes	The playbook ID. Note You can call the DescribePlaybooks operation to query this ID.	123
RequestUuid	string	Yes	The UUID of the playbook task execution. Note You can call the DescribeSoarRecords operation to query this UUID.	a15e37da-abe0-4d87-acd2-024e875a****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0B48AB3C-84FC-424D-A01D-B9270EF4****
TaskDetail	object	The task details.
LogInfo	string	The log information of the task.	{"status":1, "errMsg":"paramError"}
ProcessInfo	string	The process information of the strategy.	{"edges":[{"level":0,"removeFlag":0,"source":1,"target":8}]}
Params	string	The parameters used to invoke the playbook.	params1
TaskName	string	The task name.	task1

Examples

Success response

JSON format

{
  "RequestId": "0B48AB3C-84FC-424D-A01D-B9270EF4****",
  "TaskDetail": {
    "LogInfo": "{\"status\":1, \"errMsg\":\"paramError\"}",
    "ProcessInfo": "{\"edges\":[{\"level\":0,\"removeFlag\":0,\"source\":1,\"target\":8}]}",
    "Params": "params1",
    "TaskName": "task1"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.