DescribePlaybooks - Security Center - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Retrieve the list of playbooks.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribePlaybooks	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Active	integer	No	Activation status of the playbook. Values: 1: Indicates the playbook is activated. 0: Indicates the playbook is not activated.	1
OwnType	string	No	Type of the playbook. Values: preset: Predefined playbook. user: Custom playbook.	user
StartMillis	long	No	Start time for the query, in 13-digit timestamp format.	1683526277415
EndMillis	long	No	End time for the query, in 13-digit timestamp format.	1683858064361
PlaybookUuid	string	No	The UUID of the playbook. Note You can use the UUID to query specific playbook information. Call the CreatePlaybook API to obtain this parameter.	8baa6cff-319e-4ede-97bc-1xxxxxx
Name	string	No	The name of the playbook.	demo_playbook
Lang	string	No	Specifies the language type for the request and response, default is zh. Values: zh: Chinese. en: English.	zh
PageSize	integer	No	Specifies the maximum number of items to display per page in a paginated query. The default number of items per page is 20. If the PageSize parameter is empty, it will return 10 items by default. Note It is recommended that the PageSize value is not empty.	10
PageNumber	long	No	Sets the page number from which to start displaying the query results. The default value is 1, indicating the first page.	1
Sort	string	No	The sorting basis, with a default value of 1. Values: 1: Last modified time. 2: Most recent execution time.	1
Order	string	No	The sorting logic, with a default value of desc. Values: desc: Descending order. asc: Ascending order.	desc
ParamTypes	string	No	The trigger method for the playbook, with a default value of query all. 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	UUID List of the playbook. Note You can use the UUID list to query specific playbook information. Call the DescribePlaybooks API to obtain this parameter.	8baa6cff-319e-4ede-97bc-1xxxxxx,7745e6cff-319e-4ede-97bc-1xxxxxx

Response parameters

Parameter	Type	Description	Example
	object	Response information.
RequestId	string	The ID of the current request, generated by Alibaba Cloud as a unique identifier for troubleshooting and problem localization.	138B5AB7-**-5814-87A3-E3E**F207E
Playbooks	array<object>	List of playbooks.
Data	object	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. Values: preset: Predefined playbook. user: Custom playbook.	user
Active	integer	The status indicator of the playbook. Values: 1: Indicates the playbook is activated. 0: Indicates the playbook is deactivated.	1
LastRuntime	long	The last execution time of the playbook, in 13-digit timestamp format.	1683526277415
GmtCreate	long	The creation time of the playbook, in 13-digit timestamp format.	1683526277415
GmtModified	string	The modification time of the playbook.	1681396398000
ParamType	string	The trigger method for the playbook, with a default value of query all. Possible values are: 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 tenant.	296004
Page	object	Pagination query information.
TotalCount	integer	The total number of items found.	100
PageNumber	integer	The page number in pagination queries.	1
PageSize	integer	The number of items per page in pagination queries.	10

Examples

Sample success responses

JSONformat

{
  "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": "296004"
    }
  ],
  "Page": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-11-01	The request parameters of the API has changed. The response structure of the API has changed	View Change Details