VerifyPlaybook - Security Center - Alibaba Cloud Documentation Center

Verifies that a playbook configuration is correct and its orchestration logic is valid.

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

get

*Playbook

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

None

Request parameters

Parameter	Type	Required	Description	Example
PlaybookUuid	string	No	The UUID of the playbook. Note Call the DescribePlaybooks operation to obtain this parameter.	9fcd3829-80ff-4681-be1e-4d2662c35fed
TaskFlow	string	No	The XML configuration of the playbook.

Response elements

Element	Type	Description	Example
	object	The response parameters for the playbook verification.
RequestId	string	The ID of the request. Alibaba Cloud generates this unique identifier for the request. Use this ID to troubleshoot and locate issues.	0DFC9403-54EB-5672-B690-9AA93C9EBB54
CheckTaskInfos	array<object>	The verification results.
	object
RiskLevel	string	The severity level of the verification message. Valid values: warn: A warning message. An issue may occur when the playbook runs. error: An error message. The playbook fails to be compiled. remind: A suggestion. This does not affect publishing or running the playbook. Optimize the playbook format.	error
NodeName	string	The name of the playbook node.	python3_3
Detail	string	The specific error message that is returned if the verification fails.	Node [python3_3] doesn't have the asset information
Prerequisites	array<object>	The prerequisite check information for the playbook.
	object
PrerequisiteType	string	The check type. Valid values: role: The name of the custom RAM role. policies: The list of RAM system policies.	role
PrerequisiteValue	string	The check content. The value is determined as follows: If PrerequisiteType is role, the value is the static field AliyunSiemSoarExecutionDefaultRole. If PrerequisiteType is policies, the value is a collection of policy names.	AliyunSiemSoarExecutionDefaultRole

Examples

Success response

JSON format

{
  "RequestId": "0DFC9403-54EB-5672-B690-9AA93C9EBB54",
  "CheckTaskInfos": [
    {
      "RiskLevel": "error",
      "NodeName": "python3_3",
      "Detail": "Node [python3_3] doesn't have the asset information"
    }
  ],
  "Prerequisites": [
    {
      "PrerequisiteType": "role",
      "PrerequisiteValue": "AliyunSiemSoarExecutionDefaultRole"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.