DescribePlaybookInputOutput - Security Center - Alibaba Cloud Documentation Center

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

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.	b724d2b0-3c3b-4223-9bfd-xxxxxxx
Lang	string	No	The language of the request and response. The default value is zh. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	The response that is returned.
RequestId	string	The ID of the request. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.	688B4CCD-5272-5DCF-9D76-FE5EFEF545F8
Config	object	The configuration information.
ParamType	string	The type of the input parameters for the playbook. template-ip: IP request template. template-file: file request template. template-process: process request template. custom: custom parameters.	custom
ExeConfig	string	The execution method of the playbook. The value is in the JSONObject format.	{ "executeMode":"mul", "cron":"0 0 1 /1 ?" }
InputParams	string	The input parameter configurations of the playbook. The value is in the JSONArray format.	[ { "typeName": "String", "dataClass": "normal", "dataType": "String", "description": "period", "example": "", "name": "period", "required": false } ]
OutputParams	string	Playbooks do not support output parameter configurations. This parameter is empty.	[]
PlaybookUuid	string	The UUID of the playbook.	9030076b-6733-4842-b05a-xxxxxx

The InputParams parameter is in JSON array format. It contains the following fields:

typeName: The name of the parameter type.
dataClass: The class of the parameter type. Valid values include normal for a standard parameter and custom for a complex parameter.
dataType: The data type of the parameter. Valid values: string, long, int, ip, file, and account.
description: The description of the parameter.
example: An example of the parameter value.
name: The name of the parameter.
required: Specifies whether the parameter is required. Valid values: true and false.

Examples

Success response

JSON format

{
  "RequestId": "688B4CCD-5272-5DCF-9D76-FE5EFEF545F8",
  "Config": {
    "ParamType": "custom",
    "ExeConfig": "{\n   \"executeMode\":\"mul\",\n  \"cron\":\"0 0 1 */1 * ?\"\n}",
    "InputParams": "[\n    {\n        \"typeName\": \"String\",\n        \"dataClass\": \"normal\",\n        \"dataType\": \"String\",\n        \"description\": \"period\",\n        \"example\": \"\",\n        \"name\": \"period\",\n        \"required\": false\n    }\n]",
    "OutputParams": "[]",
    "PlaybookUuid": "9030076b-6733-4842-b05a-xxxxxx"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.