TriggerSophonPlaybook - Security Center - Alibaba Cloud Documentation Center

Operation description

Before calling this operation, ensure you understand the billing methods and pricing for response orchestration.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CommandName	string	No	The name of the command to trigger. Note Call the DescribeSophonCommands operation to obtain the command name.	waf_process_command
InputParams	string	Yes	The input parameters to trigger the command or playbook.	{ "param1": "xx.xx.xx.xx", "param2": "7d" }
SophonTaskId	string	No	A custom ID for the task. If you do not specify this parameter when you trigger the playbook, a random ID is generated. You can use the ID to locate and troubleshoot issues.	f916b93e-e814-459f-9662-xxxxxxxxxx
Uuid	string	No	The UUID of the playbook. Note Call the DescribePlaybooks operation to obtain the playbook UUID.	f916b93e-e814-459f-9662-xxxxxxxxxx
TriggerType	string	No	The trigger type. Valid values: command: triggers a command task playbook: triggers a playbook task	playbook

Response elements

Element	Type	Description	Example
	object	The information returned.
Data	object	The details returned after the command or playbook is triggered.
SophonTaskId	string	A custom ID for the task. If you do not specify this parameter when you trigger the playbook, a random ID is generated. You can use the ID to locate and troubleshoot issues.	a7c6d055-a72f-4676-bc89-3cd9edc0284c
RequestId	string	The ID of the request. Alibaba Cloud generates a unique ID for each request. Use the request ID to troubleshoot issues.	0DFC9403-54EB-5672-B690-9AA93C9EBB54

Examples

Success response

JSON format

{
  "Data": {
    "SophonTaskId": "a7c6d055-a72f-4676-bc89-3cd9edc0284c"
  },
  "RequestId": "0DFC9403-54EB-5672-B690-9AA93C9EBB54"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.