用于配置自动响应计划时,获取可执行的剧本列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-sas:DescribeExecutePlaybooks | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InputMode | string | 否 | 剧本入参的实体类型,当要想询多个实体类型时,以逗号分隔。
| ip,file,process,host |
PlaybookName | string | 否 | 剧本的名称,支持模糊搜索。 | demo_test |
Uuid | string | 否 | 剧本的 UUID。 说明
调用 DescribePlaybooks 接口可以获取该参数。
| f916b93e-e814-459f-9662-xxxxxx |
Lang | string | 否 | 请求和接收消息的语言类型。取值:
| zh |
ParamType | string | 否 | 剧本的入参类型。
| custom |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "88A39217-2802-5B1E-BA2B-CF1BBC43C1F5",
"PlaybookMetrics": [
{
"Description": "a demo playbook",
"DisplayName": "demo_playbook",
"Uuid": "c5c88b5e-97ca-435d-8c20-2xxxxx",
"ParamConfig": "[\n {\n \"typeName\": \"String\",\n \"dataClass\": \"normal\",\n \"dataType\": \"String\",\n \"description\": \"period\",\n \"example\": \"\",\n \"name\": \"period\",\n \"required\": false\n }\n]",
"ParamType": "custom"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2024-03-19 | OpenAPI 入参发生变更 | 看变更集 | ||||
|