RunNotifyComponentWithMessageCenter - 通知组件-测试消息中心的消息发送

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

接口说明

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

调试

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

授权信息

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

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

请求参数

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

接收消息的用户 ID。

146789xxxx733152
EventIdstring

云鸽的消息事件 ID。取值:

  • yundun_soar_incident_generate:事件生成
  • yundun_soar_alert_generate:告警生成
  • yundun_soar_incident_update:事件更新
yundun_soar_incident_generate
Paramsstring

消息事件的模版参数。

  • 事件生成:aliyunUID、incidentName、incidentID、startTime
  • 告警生成:aliyunUID、alertName、alertID、startTime
  • 事件更新:aliyunUID、incidentName、incidentID、startTime、endTime、status、level
{"startTime":"test222","incidentName":"test123","incidentID":"teset123"}
ChannelTypeListarray

通道类型集合,不传则默认发送所有通道,默认不传。

ChannelTypeListstring

单个通道类型。取值:

  • sms:短信
  • email:邮件
  • webhook:钉钉群 webhook
  • pmsg:站内信
sms
PlaybookUuidstring

剧本的 UUID。

说明 调用 DescribePlaybooks 接口可以获取该参数。
c5c88b5e-97ca-435d-8c20-xxxxxx
NodeNamestring

剧本的节点名称。

notify_message
ComponentNamestring

剧本的组件名称。

NotifyMessage
ActionNamestring

剧本的动作名称。

notifyByMessageCenter
AssetIdinteger

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

1
Langstring

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

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

视图类型。取值:

  • 0(默认):当前阿里云账号视图。
  • 1:企业下所有账号的视图。
0
RoleForlong

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

1467894xxx733152

返回参数

名称类型描述示例值
object

SophonResult

RequestIdstring

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

E7698CFB-4E1C-5840-8EC9-691B86729E94
Datastring

接口返回数据。

{}
Pageobject

分页查询信息。

TotalCountinteger

列表条目数。

30
PageNumberinteger

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

1
PageSizeinteger

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

10

示例

正常返回示例

JSON格式

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

错误码

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