创建剧本。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| yundun-sas:CreatePlaybook | create | *Playbook acs:yundun-sas::{#accountId}:playbook/* |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Lang | string | 否 | 接收消息的语言类型。取值:
| zh |
| RoleFor | long | 否 | 资源目录成员账号 ID。 | 170*********3093 |
| PlaybookName | string | 是 | 剧本的名称,不包含特殊字符。 | waftest |
| PlaybookDescription | string | 否 | 剧本描述。 | waf ip block |
| PlaybookInputConfigs | array | 否 | 剧本的输入参数配置。 | |
| FieldInputConfig | 否 | 输入参数配置。 | ||
| PlaybookOutputConfigs | array | 否 | 剧本的输出参数配置。 | |
| FieldOutputConfig | 否 | 输出参数配置。 | ||
| SrcPlaybookUuid | string | 否 | 复制场景下需要填入的源剧本的 UUID,该参数存在值时,除剧本名称和剧本描述外其余参数无效。 | 1B5A9144-****-****-A466-****9D64AA99 |
| PlaybookTaskFlow | string | 否 | 剧本的工作流。 | [{"id":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4","zIndex":1,"data":{"nodeType":"startEvent","appType":"basic","nodeName":"start","icon":"icon-circle","description":"start"},"position":{"x":-440,"y":-170}},{"id":"5293c3f9-e1c9-4a49-b0eb-635067dc67e8","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4"},"target":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"vertices":[]},{"id":"317dd1be-2d20-460e-977e-1fc936ffb583","zIndex":1,"data":{"nodeType":"endEvent","appType":"basic","nodeName":"end","icon":"icon-radio-off-full","description":"end"},"position":{"x":-140,"y":-170}},{"id":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2","zIndex":1,"data":{"isDebug":false,"nodeType":"action","appType":"component","nodeName":"data","valueData":{"outputFields":"[{\"fieldName\":\"ip\",\"fieldValue\":\"${event.ip}\"}]"},"icon":"https://img.alicdn.com/imgextra/i2/O1CN01NCKmL026m1z8o0DeN_!!6000000007703-2-tps-248-248.png","description":"","advance":{"inputParamMode":false,"onError":"stop_cur_flow","rspStatusType":3,"rspStatusThreshold":0},"componentName":"DataFormat","actionName":"formatdata"},"position":{"x":-340,"y":-185}},{"id":"1c7f0021-fb93-4478-b10f-af78dd5a69d6","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"target":{"cell":"317dd1be-2d20-460e-977e-1fc936ffb583"},"vertices":[]}] |
| PlaybookParamType | string | 否 | 剧本的参数类型,取值如下:
| custom |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "007BC211-709E-549B-9534-4C8EA0922828",
"PlaybookUuid": "e99dab31-499b-4307-9248-xxxxxx"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-11-24 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2025-10-27 | 新增 OpenAPI | 查看变更详情 |
