DescribeSoarPlaybookTaskDetail - Security Center - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query the execution details of a remediation task playbook

Operation description

This API is only supported by the Enterprise and Flagship editions of Cloud Security Center, other versions do not support it.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeSoarPlaybookTaskDetail	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RecordId	long	Yes	The vulnerability ID passed when creating the policy task. Note You can obtain this parameter by calling the DescribeVulList interface.	14
PlaybookId	long	Yes	Playbook ID. Note You can obtain this parameter by calling the DescribePlaybooks interface.	123
RequestUuid	string	Yes	UUID of the playbook task execution. Note You can obtain this parameter by calling the DescribeSoarRecords interface.	a15e37da-abe0-4d87-acd2-024e875a****

Response parameters

Parameter	Type	Description	Example
	object	Return content.
RequestId	string	The ID of the current call request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used to troubleshoot and locate issues.	0B48AB3C-84FC-424D-A01D-B9270EF4****
TaskDetail	object	Task details.
LogInfo	string	Log information of the task.	{"status":1, "errMsg":"paramError"}
ProcessInfo	string	Process information corresponding to the strategy.	{"edges":[{"level":0,"removeFlag":0,"source":1,"target":8}]}
Params	string	Parameters for invoking the playbook.	params1
TaskName	string	Task name.	task1

Examples

Sample success responses

JSONformat

{
  "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
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

For a list of error codes, visit the Service error codes.