DescribeSoarStrategyTasks - Security Center - Alibaba Cloud Documentation Center

Queries a list of policy tasks on the Playbook page.

Operation description

Only the Enterprise and Ultimate editions of Security Center support this API operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
- The required resource types are displayed in bold characters.
- 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:DescribeSoarStrategyTasks	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	Yes	The page number. Pages start from page 1.	1
PageSize	integer	Yes	The number of entries per page.	20

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	24A20733-10A0-4AF6-BE6B-E3322413BB68
PageSize	integer	The number of entries per page.	20
PageNumber	integer	The page number. Pages start from page 1.	1
TotalCount	integer	The total number of entries returned.	100
SoarStrategyTasks	array<object>	The policy tasks.
	object	The details of the policy task.
Status	string	The status of the policy task. Valid values: -1: waiting 0: starting 1: running 2: finished 3: schedule 4: pause	0
FailedNum	integer	The number of execution failures.	20
StrategyId	long	The ID of the policy.	8000
GmtCreate	long	The timestamp when the policy task was created. Unit: milliseconds.	1708481235000
SuccessNum	integer	The number of successful executions.	20
TotalNum	integer	The total number of executions.	20
RunMode	string	The execution mode. Valid values: runmode_TRIGGER_BY_USER: manually executed	runmode_TRIGGER_BY_USER
Name	string	The name of the policy task.	strategy_name01
GmtModified	long	The timestamp when the policy task was modified. Unit: milliseconds.	1669869436000
Id	long	The ID of the policy task.	5374
GmtFinish	long	The timestamp when the policy task was complete. Unit: milliseconds.	1586739841000

Examples

Sample success responses

JSONformat

{
  "RequestId": "24A20733-10A0-4AF6-BE6B-E3322413BB68",
  "PageSize": 20,
  "PageNumber": 1,
  "TotalCount": 100,
  "SoarStrategyTasks": [
    {
      "Status": "0",
      "FailedNum": 20,
      "StrategyId": 8000,
      "GmtCreate": 1708481235000,
      "SuccessNum": 20,
      "TotalNum": 20,
      "RunMode": "runmode_TRIGGER_BY_USER",
      "Name": "strategy_name01",
      "GmtModified": 1669869436000,
      "Id": 5374,
      "GmtFinish": 1586739841000
    }
  ]
}

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.