DescribePlaybook - Security Center - Alibaba Cloud Documentation Center

Retrieves the XML configuration of a playbook.

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

get

*Playbook

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

None

Request parameters

Parameter	Type	Required	Description	Example
PlaybookUuid	string	Yes	The UUID of the playbook. Note Call the DescribePlaybooks operation to obtain this parameter.	9030076b-6733-4842-b05a-xxxxx
Lang	string	No	The language of the request and response. The default value is zh. Valid values: zh: Chinese en: English	zh
TaskflowMd5	string	No	The MD5 value of the playbook configuration.	7a8f608dc64c242632aa578xxxxx
DebugFlag	integer	No	A flag that indicates whether the version is a published version or a debug version. Valid values: 1: retrieves the debug version. 0: retrieves the published version.	0

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID. This is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot and locate issues.	2989BC59-E9F0-5C83-B453-B368857649C8
Playbook	object	The configuration of the playbook.
GmtCreate	string	The time when the playbook was created. This is a 13-digit timestamp.	1665288858000
GmtModified	string	The time when the playbook was last modified. This is a 13-digit timestamp.	1677482519000
PlaybookUuid	string	The UUID of the playbook.	8db257d3-e2b2-44fd-b2cc-xxxxx
Taskflow	string	The XML configuration of the playbook.
TaskflowType	string	The configuration format of the playbook. xml: XML format. x6: JSON format.	xml
OwnType	string	The type of the playbook. Valid values: preset: predefined playbook. user: custom playbook.	preset
SuccessExeNum	integer	The number of times the playbook was successfully run.	100
FailExeNum	integer	The number of times the playbook failed to run.	1
LastExeTime	integer	The last time when the playbook was run. This is a 13-digit timestamp.	1665288858000
DisplayName	string	The display name of the playbook.	demo_test
InputParams	string	The input parameter configuration of the playbook. The value is a JSONArray string. Note For more information about the format, see DescribePlaybookInputOutput.	[ { "typeName": "String", "dataClass": "normal", "dataType": "String", "description": "period", "example": "", "name": "period", "required": false } ]
Description	string	The description of the playbook.	demo playbook
OnlineActive	boolean	A flag that indicates whether the playbook is enabled. Valid values: 0: The playbook is disabled. 1: The playbook is enabled.	0
OnlineReleaseTaskflowMd5	string	The MD5 value of the latest published version of the playbook.	asdfsdfe232-e2b2-44fd-b2cc-xxxxx

Examples

Success response

JSON format

{
  "RequestId": "2989BC59-E9F0-5C83-B453-B368857649C8",
  "Playbook": {
    "GmtCreate": "1665288858000",
    "GmtModified": "1677482519000",
    "PlaybookUuid": "8db257d3-e2b2-44fd-b2cc-xxxxx",
    "Taskflow": "",
    "TaskflowType": "xml",
    "OwnType": "preset",
    "SuccessExeNum": 100,
    "FailExeNum": 1,
    "LastExeTime": 1665288858000,
    "DisplayName": "demo_test",
    "InputParams": "[\n    {\n        \"typeName\": \"String\",\n        \"dataClass\": \"normal\",\n        \"dataType\": \"String\",\n        \"description\": \"period\",\n        \"example\": \"\",\n        \"name\": \"period\",\n        \"required\": false\n    }\n]",
    "Description": "demo playbook",
    "OnlineActive": true,
    "OnlineReleaseTaskflowMd5": "asdfsdfe232-e2b2-44fd-b2cc-xxxxx"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.