Retrieve SOAR Playbooks via DescribePlaybooks API - Security Center - Alibaba Cloud - Security Center

Retrieves a list of playbooks.

Operation description

Before using this operation, make sure that you fully understand the billing method of the response orchestration product (threat analysis and response log ingestion traffic).

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

get

*Playbook

acs:yundun-sas::{#accountId}:playbook/*

None

Request parameters

Parameter	Type	Required	Description	Example
Active	integer	No	The status of the playbook. Valid values: 1: Enabled. 0: Disabled.	1
OwnType	string	No	The type of the playbook. Valid values: preset: predefined playbook. user: custom playbook.	user
StartMillis	integer	No	The start time of the query. Format: 13-digit timestamp.	1683526277415
EndMillis	integer	No	The end time of the query. Format: 13-digit timestamp.	1683858064361
PlaybookUuid	string	No	The UUID of the playbook. Note You can call the CreatePlaybook operation to obtain this parameter.	8baa6cff-319e-4ede-97bc-1xxxxxx
Name	string	No	The name of the playbook.	demo_playbook
Lang	string	No	The language type of the request and response. Default value: zh. Valid values: zh: Chinese. en: English.	zh
PageSize	integer	No	The maximum number of entries per page in a paginated query. The default number of entries per page is 20. If the PageSize parameter is left empty, 10 entries are returned by default. Note Do not leave PageSize empty.	10
PageNumber	integer	No	The page number from which to start displaying query results. Default value: 1, which indicates that results are displayed starting from page 1.	1
Sort	integer	No	The sorting basis. Default value: 1. Valid values: 1: last modified time. 2: last execution time.	1
Order	string	No	The sort order. Default value: desc. Valid values: desc: descending order. asc: ascending order.	desc
ParamTypes	string	No	The playbook trigger type. Default value: query all. Valid values: template-incident: security incident. template-ip: IP entity. template-file: file entity. template-process: process entity. template-alert: security alert. template-domain: domain entity. template-container: container entity. template-host: host entity. template-custom: custom.	template-alert
PlaybookUuids	string	No	The collection of playbook UUIDs. A maximum of 100 UUIDs are supported. Separate multiple UUIDs with commas (,).	8baa6cff-319e-4ede-97bc-1xxxxxx,8rrt6cff-319e-4ede-97bc-1xxxxxx

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use it to troubleshoot issues.	138B5AB7-**-5814-87A3-E3E**F207E
Playbooks	array<object>	The list of playbooks.
	object	The playbook information.
DisplayName	string	The display name of the playbook.	demo_playbook
PlaybookUuid	string	The UUID of the playbook.	bb5a8640-a14f-44ef-8376-cxxxxx
OwnType	string	The type of the playbook. Valid values: preset: predefined playbook. user: custom playbook.	user
Active	integer	The status of the playbook. Valid values: 1: Enabled. 0: Disabled.	1
LastRuntime	integer	The last execution time of the playbook. Format: 13-digit timestamp.	1683526277415
GmtCreate	integer	The creation time of the playbook. Format: 13-digit timestamp.	1683526277415
GmtModified	string	The modification time of the playbook.	1681396398000
ParamType	string	The playbook trigger type. Default value: query all. Valid values: template-incident: security incident. template-ip: IP entity. template-file: file entity. template-process: process entity. template-alert: security alert. template-domain: domain entity. template-container: container entity. template-host: host entity.	template-alert
Description	string	The description of the playbook.	aegis_kill_process
TenantId	string	The ID of the user to whom the playbook belongs.	123456
Page	object	The pagination information.
TotalCount	integer	The total number of entries returned.	100
PageNumber	integer	The page number of the current page in a paginated query.	1
PageSize	integer	The number of entries per page in a paginated query.	10

Examples

Success response

JSON format

{
  "RequestId": "138B5AB7-****-5814-87A3-E3E****F207E",
  "Playbooks": [
    {
      "DisplayName": "demo_playbook",
      "PlaybookUuid": "bb5a8640-a14f-44ef-8376-cxxxxx",
      "OwnType": "user",
      "Active": 1,
      "LastRuntime": 1683526277415,
      "GmtCreate": 1683526277415,
      "GmtModified": "1681396398000",
      "ParamType": "template-alert",
      "Description": "aegis_kill_process",
      "TenantId": "123456"
    }
  ],
  "Page": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.