RunNotifyComponentWithWebhook - 通知组件-测试webhook发送

执行通知组件-webhook发送消息。

接口说明

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

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:RunNotifyComponentWithWebhook

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Webhook

string

消息中心-机器人接收管理页面配置的机器人 ID 集合,目前只支持钉钉机器人类型。

[\"10651\"]

Secret

string

钉钉群机器人 webhook 消息秘钥。当前此参数已废弃,不再使用。

SECc1*****e157b32b380f********bb8c70e1a67a22072

MsgType

string

webhook 消息类型。取值:

  • text

  • markdown

  • actionCard

text

Content

string

钉钉群机器人 webhook 发送的消息正文。

{ "at": { "atMobiles":[ "180xxxxxx" ], "atUserIds":[ "user123" ], "isAtAll": false }, "text": { "content":"1234" }, "msgtype":"text" }

PlaybookUuid

string

剧本的 UUID。

说明

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

94bc318c-****-4cba-****-801ccb0d739f

NodeName

string

剧本的节点名称。

notify_message_node

ComponentName

string

剧本的组件名称。

NotifyMessage

ActionName

string

剧本的动作名称。

notifyByCustom

AssetId

integer

资源实例 ID。当前此参数已废弃,不再使用。

1

Lang

string

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

  • zh(默认):中文。

  • en:英文。

zh

RoleType

string

视图类型。取值:

  • 0(默认):当前阿里云账号视图。

  • 1:企业下所有账号的视图。

0

RoleFor

integer

管理员切换成其他成员视角的用户 ID。

126339xxxx805497

返回参数

名称

类型

描述

示例值

object

SophonResult

RequestId

string

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

E7698CFB-****-5840-8EC9-691B86729E94

Data

string

接口返回数据内容。

{}

Page

object

分页查询信息。

TotalCount

integer

总数,分页查询时生效。

30

PageNumber

integer

分页查询时,当前页的页码。

1

PageSize

integer

分页查询时,每页显示的条目数量。

10

示例

正常返回示例

JSON格式

{
  "RequestId": "E7698CFB-****-5840-8EC9-691B86729E94",
  "Data": "{}",
  "Page": {
    "TotalCount": 30,
    "PageNumber": 1,
    "PageSize": 10
  }
}

错误码

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

变更历史

更多信息,参考变更详情