TriggerSophonPlaybook - 触发剧本或响应命令

用于触发运行剧本或响应命令。

接口说明

请确保在使用该接口前,已充分了解响应编排产品的收费方式和价格

调试

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

授权信息

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

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

请求参数

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

想要触发的命令名称。

说明 调用 DescribeSophonCommands 接口可以获取该参数。
waf_process_command
InputParamsstring

触发命令或剧本的输入参数。

{ "param1": "xx.xx.xx.xx", "param2": "7d" }
SophonTaskIdstring

业务的自定义 ID,如果触发剧本时不指定,会产生一个随机的 ID,用于排查与定位问题。

f916b93e-e814-459f-9662-xxxxxxxxxx
Uuidstring

剧本的 UUID。

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

触发类型,取值:

  • command:触发命令任务
  • playbook:触发剧本任务
playbook

返回参数

名称类型描述示例值
object

请求返回信息。

Dataobject

触发命令或剧本后的返回详情。

SophonTaskIdstring

业务的自定义 ID,如果触发剧本时不指定,会产生一个随机的 ID,用于排查与定位问题。

a7c6d055-a72f-4676-bc89-3cd9edc0284c
RequestIdstring

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

0DFC9403-54EB-5672-B690-9AA93C9EBB54

示例

正常返回示例

JSON格式

{
  "Data": {
    "SophonTaskId": "a7c6d055-a72f-4676-bc89-3cd9edc0284c"
  },
  "RequestId": "0DFC9403-54EB-5672-B690-9AA93C9EBB54"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史