文档

DescribeExecutePlaybooks - 获取可执行的剧本列表

更新时间:

用于配置自动响应计划时,获取可执行的剧本列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeExecutePlaybooksRead
  • acs:yundun-sas::{#accountId}:*

请求参数

名称类型必填描述示例值
InputModestring

剧本入参的实体类型,当要想询多个实体类型时,以逗号分隔。

  • ip:IP 实体。
  • file:文件实体。
  • process:进程实体。
  • incident:事件实体。
ip,file,process,host
PlaybookNamestring

剧本的名称,支持模糊搜索。

demo_test
Uuidstring

剧本的 UUID。

说明 调用 DescribePlaybooks 接口可以获取该参数。
f916b93e-e814-459f-9662-xxxxxx
Langstring

请求和接收消息的语言类型。取值:

  • zh(默认):中文
  • en:英文
zh
ParamTypestring

剧本的入参类型。

  • template-ip:IP 请求模板。
  • template-file:文件请求模板。
  • template-process:进程请求模板。
  • custom:自定义参数。
custom

返回参数

名称类型描述示例值
object

返回信息。

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

88A39217-2802-5B1E-BA2B-CF1BBC43C1F5
PlaybookMetricsobject []

剧本列表。

Descriptionstring

剧本的描述信息。

a demo playbook
DisplayNamestring

剧本的名称。

demo_playbook
Uuidstring

剧本的 UUID。

c5c88b5e-97ca-435d-8c20-2xxxxx
ParamConfigstring

剧本的入参配置,为 JSONArray 格式。

说明 参考 DescribePlaybookInputOutput 接口的格式说明。
[ { "typeName": "String", "dataClass": "normal", "dataType": "String", "description": "period", "example": "", "name": "period", "required": false } ]
ParamTypestring

剧本的入参类型。

  • template-ip:IP 请求模板。
  • template-file:文件请求模板。
  • template-process:进程请求模板。
  • custom:自定义参数。
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-19OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:InputMode