ExecuteComponent - 执行组件

更新时间:
复制 MD 格式

执行剧本中的组件,并输出组件的运行结果。

接口说明

请确保在使用该接口前,已充分了解响应编排产品(即威胁分析与响应日志接入流量)的收费方式和价格。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:ExecuteComponent

none

*Component

acs:yundun-sas::{#accountId}:component/{#ComponentName}

无 无

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

PlaybookUuid

string

否

剧本的 UUID。

说明

调用 DescribePlaybooks 接口可以获取该参数。

ac343acc-1a61-4084-9a1cxxxxx

PlayBookNodeName

string

否

当前组件在剧本中对应的节点名称。

node1

ComponentName

string

否

组件的名称。

SLS

ComponentActionName

string

否

组件的动作名称。

doRequest

ComponentAssetUuid

string

否

资产 UUID。

1C5F11E9-****-51F0-****-43BB312A0557

ComponentInput

string

否

组件输入参数

{}

Lang

string

否

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

  • zh(默认):中文。

  • en:英文。

zh

返回参数

名称

类型

描述

示例值

object

Schema of Response

RunResult

string

组件运行结果。

{ "requestUuid": "fe240b98-27b1-4a36-aec1-550b894318d9", "content": { "resultData": [], "success": true } }

RequestId

string

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

10B92EE1-4597-593B-A131-7A17D25EF5C9

示例

正常返回示例

JSON格式

{
  "RunResult": "{\n    \"requestUuid\": \"fe240b98-27b1-4a36-aec1-550b894318d9\",\n    \"content\": {\n        \"resultData\": [],\n        \"success\": true\n    }\n}",
  "RequestId": "10B92EE1-4597-593B-A131-7A17D25EF5C9"
}

错误码

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

变更历史

更多信息,参考变更详情。