TriggerPlaybook-阿里云帮助中心

Operation description

Before using this operation, make sure that you fully understand the billing method and pricingof the Security Orchestration Automation Response (SOAR) product (that is, the traffic for log ingestion in threat analysis and response).

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

update

*Playbook

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

None

Request parameters

Parameter	Type	Required	Description	Example
PlaybookUuid	string	Yes	The UUID of the playbook. Note You can call the DescribePlaybooks operation to obtain this parameter.	2a687089-d4dd-47d4-9709-xxxxxxxx
InputParam	string	Yes	The input parameters of the playbook.	{ "input1": "xx.xx.xx.xx", "input2": "7d" }

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 this ID to troubleshoot issues.	BD5A8DB6-A42C-532B-BCE8-83E69550CD59
TriggerUuid	string	The UUID of the playbook execution. You can use this UUID to retrieve the execution result of the playbook.	55E63C57-D6C8-5036-A770-5CB10AC807AA

Examples

Success response

JSON format

{
  "RequestId": "BD5A8DB6-A42C-532B-BCE8-83E69550CD59",
  "TriggerUuid": "55E63C57-D6C8-5036-A770-5CB10AC807AA"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.