DescribeExecutePlaybooks - Security Center - Alibaba Cloud Documentation Center

Queries a list of executable playbooks that are used to configure automated response plans.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InputMode	string	No	The entity type of the input parameter for the playbook. To query multiple entity types, separate them with commas. ip: IP entity. file: file entity. process: process entity. incident: event entity.	ip,file,process,host
PlaybookName	string	No	The name of the playbook. Fuzzy search is supported.	demo_test
Uuid	string	No	The UUID of the playbook. Note Call the DescribePlaybooks operation to obtain this parameter.	f916b93e-e814-459f-9662-xxxxxx
Lang	string	No	The language of the request and response. Valid values: zh (default): Chinese en: English	zh
ParamType	string	No	The type of the input parameter for the playbook. template-ip: IP request template. template-file: file request template. template-process: process request template. custom: custom parameter.	custom

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The ID of the request. This ID is unique to the request and is generated by Alibaba Cloud. Use this ID to troubleshoot issues.	88A39217-2802-5B1E-BA2B-CF1BBC43C1F5
PlaybookMetrics	array<object>	The list of playbooks.
	object	Summary information about the playbook.
Description	string	The description of the playbook.	a demo playbook
DisplayName	string	The name of the playbook.	demo_playbook
Uuid	string	The UUID of the playbook.	c5c88b5e-97ca-435d-8c20-2xxxxx
ParamConfig	string	The configuration of the input parameters for the playbook. The value is in the JSONArray format. Note For more information about the format, see the DescribePlaybookInputOutput operation.	[ { "typeName": "String", "dataClass": "normal", "dataType": "String", "description": "period", "example": "", "name": "period", "required": false } ]
ParamType	string	The type of the input parameter for the playbook. template-ip: IP request template. template-file: file request template. template-process: process request template. custom: custom parameter.	custom

Examples

Success response

JSON format

{
  "RequestId": "88A39217-2802-5B1E-BA2B-CF1BBC43C1F5",
  "PlaybookMetrics": [
    {
      "Description": "a demo playbook",
      "DisplayName": "demo_playbook",
      "Uuid": "c5c88b5e-97ca-435d-8c20-2xxxxx",
      "ParamConfig": "[\n    {\n        \"typeName\": \"String\",\n        \"dataClass\": \"normal\",\n        \"dataType\": \"String\",\n        \"description\": \"period\",\n        \"example\": \"\",\n        \"name\": \"period\",\n        \"required\": false\n    }\n]",
      "ParamType": "custom"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.