DescribePlaybookInputOutput - Security Center - Alibaba Cloud Documentation Center

Queries the input and output parameter configurations of a playbook.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribePlaybookInputOutput	get	*Playbook `acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
PlaybookUuid	string	Yes	The UUID of the playbook. Note You can call the DescribePlaybooks operation to query the UUIDs of playbooks.	b724d2b0-3c3b-4223-9bfd-xxxxxxx
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	688B4CCD-5272-5DCF-9D76-FE5EFEF545F8
Config	object	The configurations.
ParamType	string	The input parameter type of the playbook. Valid values: template-ip template-file template-process custom	custom
ExeConfig	string	The execution method of the playbook is in JSONObject format.	{ "executeMode":"mul", "cron":"0 0 1 /1 ?" }
InputParams	string	The input parameter configuration of the playbook. The value is a JSON array.	[ { "typeName": "String", "dataClass": "normal", "dataType": "String", "description": "period", "example": "", "name": "period", "required": false } ]
OutputParams	string	The output parameter configuration. This parameter is unavailable and is always left empty.	[]
PlaybookUuid	string	The UUID of the playbook.	9030076b-6733-4842-b05a-xxxxxx

The value of InputParams is a JSON array, which contains the following fields:

typeName: the data type name of the parameter.
dataClass: the level of the parameter type. Valid values are normal and custom. The value normal indicates a common parameter, and the value custom indicates a complex parameter.
dataType: the type of the parameter. Valid values are string, long, int, ip, file, and account.
description: the description of the parameter.
example: the example value of the parameter.
name: the name of the parameter.
required: specifies whether the parameter is required. Valid values are true and false.

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-03-21	The response structure of the API has changed	View Change Details
2024-03-15	The response structure of the API has changed	View Change Details
2024-01-16	The response structure of the API has changed	View Change Details