DescribePlaybooks - Security Center - Alibaba Cloud Documentation Center

Queries a list of playbooks.

Operation description

Before you call this operation, make sure that you understand the billing methods and pricing for Security Orchestration, Automation, and Response (SOAR).

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: The playbook is enabled. 0: The playbook is disabled.	1
OwnType	string	No	The type of the playbook. Valid values: preset: predefined playbook. user: custom playbook.	user
StartMillis	integer	No	The start of the time range to query. This value is a 13-digit timestamp.	1683526277415
EndMillis	integer	No	The end of the time range to query. This value is a 13-digit timestamp.	1683858064361
PlaybookUuid	string	No	The UUID of the playbook. Note 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 of the content within the request and response. Default value: zh. Valid values: zh: Chinese. en: English.	zh
PageSize	integer	No	The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 10 entries are returned by default. Note Specify a value for this parameter.	10
PageNumber	integer	No	The page number of the page to return. Default value: 1.	1
Sort	integer	No	The field to sort by. Default value: 1. Valid values: 1: last modification time. 2: last running time.	1
Order	string	No	The sort order. Default value: desc. Valid values: desc: descending. asc: ascending.	desc
ParamTypes	string	No	The trigger type of the playbook. If you do not specify this parameter, playbooks of all trigger types are queried. Valid values: template-incident: security event. template-ip: IP entity. template-file: file entity. template-process: process entity. template-alert: security alert. template-domain: domain name entity. template-container: container entity. template-host: host entity. template-custom: custom.	template-alert
PlaybookUuids	string	No	A comma-separated list of playbook UUIDs. You can specify up to 100 UUIDs.	8baa6cff-319e-4ede-97bc-1xxxxxx,8rrt6cff-319e-4ede-97bc-1xxxxxx

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID. This ID is generated by Alibaba Cloud for the request and can be used to troubleshoot issues.	138B5AB7-**-5814-87A3-E3E**F207E
Playbooks	array<object>	The list of playbooks.
	object	The information about the playbook.
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: The playbook is enabled. 0: The playbook is disabled.	1
LastRuntime	integer	The last time the playbook was run. This value is a 13-digit timestamp.	1683526277415
GmtCreate	integer	The time when the playbook was created. This value is a 13-digit timestamp.	1683526277415
GmtModified	string	The time when the playbook was modified.	1681396398000
ParamType	string	The trigger type of the playbook. Valid values: template-incident: security event. template-ip: IP entity. template-file: file entity. template-process: process entity. template-alert: security alert. template-domain: domain name 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 which the playbook belongs.	123456
Page	object	The pagination information.
TotalCount	integer	The total number of entries that match the query.	100
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	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.