DescribeSoarStrategyTasks API Reference & Parameters - Security Center - Alibaba Cloud - Security 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.

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

get

*All Resource

*

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 elements

Element	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	integer	The ID of the policy.	8000
GmtCreate	integer	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	integer	The timestamp when the policy task was modified. Unit: milliseconds.	1669869436000
Id	integer	The ID of the policy task.	5374
GmtFinish	integer	The timestamp when the policy task was completed. Unit: milliseconds.	1586739841000

Examples

Success response

JSON format

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