All Products
Search
Document Center

Security Center:ModifyPlaybookInputOutput

Last Updated:Dec 23, 2025

Modifies the input and output parameters 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:ModifyPlaybookInputOutput

update

*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

Call the DescribePlaybooks operation to obtain this parameter.

8baa6cff-319e-4ede-97bc-xxxxxxx

InputParams

string

Yes

The input parameter configuration for the playbook. This parameter is in the JSONArray format.

[ { "typeName": "String", "dataClass": "normal", "dataType": "String", "description": "period", "example": "", "name": "period", "required": false } ]

OutputParams

string

Yes

Playbooks do not support output parameter configurations. This parameter is fixed to an empty value.

[]

ParamType

string

No

The type of the input parameter for the playbook.

  • template-ip: IP request template.

  • template-file: file request template.

  • template-process: process request template.

  • custom: custom parameter.

custom

ExeConfig

string

No

The execution method for the playbook. This parameter is in the JSONObject format.

{ "executeMode":"mul", "cron":"0 0 1 */1 * ?" }

Lang

string

No

The language of the request and response messages.

  • zh (default): Chinese

  • en: English

zh

InputParams is in the JSONArray format. The parameters are described as follows:

  • typeName: The name of the parameter type.

  • dataClass: The class of the parameter type. Valid values: 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 parameter description.

  • example: An example value for the parameter.

  • name: The parameter name.

  • required: Specifies whether the parameter is required. Valid values: true and false.

ExeConfig is in the JSONObject format. The parameters are described as follows:

  • executeMode: The execution method. The only valid value is mul.

  • cron: The CRON expression. The expression must follow the CRON standard.

Response elements

Element

Type

Description

Example

object

The response.

RequestId

string

The ID of the request. This ID is a unique identifier that is generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.

8DDC07CE-D41B-5142-8D91-469462719C77

Examples

Success response

JSON format

{
  "RequestId": "8DDC07CE-D41B-5142-8D91-469462719C77"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.