用于获取剧本的输入参数与输出参数的配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| yundun-sas:DescribePlaybookInputOutput | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PlaybookUuid | string | 是 | 剧本的 UUID。 说明
调用 DescribePlaybooks 接口可以获取该参数。
| b724d2b0-3c3b-4223-9bfd-xxxxxxx |
| Lang | string | 否 | 设置请求和接收消息的语言类型，默认为 zh。取值：
| zh |
返回参数
InputParams 为 JSONArray 格式，具体参数说明：
- typeName：参数类型名称。
- dataClass：参数类型等级，可选值，normal 表示普通参数，custom 表示复杂参数。
- dataType：参数类型，可选值，string、long、int、ip、file、account。
- description：参数的描述说明。
- example：参数的示例。
- name：参数名称。
- required：参数是否必填，可选值，true 表示必填，false 表示不必填
示例
正常返回示例
JSON格式
{
"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"
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||
|---|---|---|---|---|
| 2024-03-21 | OpenAPI 返回结构发生变更 | 看变更集 | ||
| ||||
| 2024-03-15 | OpenAPI 返回结构发生变更 | 看变更集 | ||
| ||||
| 2024-01-16 | OpenAPI 返回结构发生变更 | 看变更集 | ||
|