SOAR Subscribed Strategy API Overview - Security Center - Alibaba Cloud - Security Center

Queries the list of custom policies created in the task center of Security Center.

Operation description

Only the Enterprise and Ultimate editions of Security Center support this API operation. Other editions do not 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:DescribeSoarSubscribedStrategy

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries per page in a paged query.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for this request. You can use it to troubleshoot issues.	0B48AB3C-84FC-424D-A01D-B9270EF46038
PageSize	integer	The number of entries per page in a paged query.	20
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries.	101
SoarStrategies	array<object>	The list of policies.
	object	The policy details.
Type	string	The policy type. Valid values: type_vulfix: vulnerability management.	type_vulfix
ExecuteNum	string	The total number of times the policy has been executed.	10
Description	string	The policy description.	strategy_description_01
GmtCreate	integer	The timestamp when the policy was created, in milliseconds.	1716344106000
RunMode	string	The execution mode. Valid values: runmode_TRIGGER_BY_USER: manual execution.	runmode_TRIGGER_BY_USER
Name	string	The policy name.	strategy_name01
GmtModified	integer	The timestamp when the policy was last modified, in milliseconds.	1652672104000
Id	integer	The policy ID.	300063
Creator	string	The Alibaba Cloud account ID of the creator.	1276085*****4392

Examples

Success response

JSON format

{
  "RequestId": "0B48AB3C-84FC-424D-A01D-B9270EF46038",
  "PageSize": 20,
  "PageNumber": 1,
  "TotalCount": 101,
  "SoarStrategies": [
    {
      "Type": "type_vulfix",
      "ExecuteNum": "10",
      "Description": "strategy_description_01",
      "GmtCreate": 1716344106000,
      "RunMode": "runmode_TRIGGER_BY_USER",
      "Name": "strategy_name01",
      "GmtModified": 1652672104000,
      "Id": 300063,
      "Creator": "1276085*****4392"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.