All Products
Search
Document Center

Security Center:DescribeSoarStrategies

Last Updated:Aug 24, 2024

Queries the policy templates 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeSoarStrategiesget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerYes

The page number. Pages start from page 1.

1
PageSizeintegerYes

The number of entries per page.

20

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

4BB99533-4FDC-5B9C-A5E4-5AE3E9BE5C78
PageSizeinteger

The number of entries per page.

20
PageNumberinteger

The page number. Pages start from page 1.

1
TotalCountinteger

The total number of entries returned.

100
SoarStrategiesarray<object>

The policies.

object

The information about the policy.

Typestring

The type of the policy. Valid values:

  • type_vulfix: vulnerability operations
type_vulfix
Descriptionstring

The description of the policy.

strategy_description_01
GmtCreatelong

The timestamp when the policy was created. Unit: milliseconds.

1703556715000
RunModestring

The execution mode. Valid values:

  • runmode_TRIGGER_BY_USER: manually executed
runmode_TRIGGER_BY_USER
GmtModifiedlong

The timestamp when the policy was modified. Unit: milliseconds.

1698114242000
Namestring

The name of the policy.

strategy_name01
Idlong

The ID of the policy.

16064025
Creatorstring

The Alibaba Cloud account ID of the creator. Default value: 0. The value indicates a system user.

0

Examples

Sample success responses

JSONformat

{
  "RequestId": "4BB99533-4FDC-5B9C-A5E4-5AE3E9BE5C78",
  "PageSize": 20,
  "PageNumber": 1,
  "TotalCount": 100,
  "SoarStrategies": [
    {
      "Type": "type_vulfix",
      "Description": "strategy_description_01",
      "GmtCreate": 1703556715000,
      "RunMode": "runmode_TRIGGER_BY_USER",
      "GmtModified": 1698114242000,
      "Name": "strategy_name01",
      "Id": 16064025,
      "Creator": "0"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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