执行通知组件-消息中心发送消息。
接口说明
请确保在使用该接口前,已充分了解响应编排产品(即威胁分析与响应日志接入流量)的收费方式和价格。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-sas:RunNotifyComponentWithMessageCenter | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Aliuid | string | 是 | 接收消息的用户 ID。 | 146789xxxx733152 |
EventId | string | 是 | 云鸽的消息事件 ID。取值:
| yundun_soar_incident_generate |
Params | string | 否 | 消息事件的模版参数。
| {"startTime":"test222","incidentName":"test123","incidentID":"teset123"} |
ChannelTypeList | array | 否 | 通道类型集合,不传则默认发送所有通道,默认不传。 | |
ChannelTypeList | string | 否 | 单个通道类型。取值:
| sms |
PlaybookUuid | string | 是 | 剧本的 UUID。 说明
调用 DescribePlaybooks 接口可以获取该参数。
| c5c88b5e-97ca-435d-8c20-xxxxxx |
NodeName | string | 是 | 剧本的节点名称。 | notify_message |
ComponentName | string | 是 | 剧本的组件名称。 | NotifyMessage |
ActionName | string | 是 | 剧本的动作名称。 | notifyByMessageCenter |
AssetId | integer | 否 | 资源实例 ID。当前此参数已废弃,不再使用。 | 1 |
Lang | string | 否 | 请求和接收消息的语言类型。取值:
| zh |
RoleType | string | 否 | 视图类型。取值:
| 0 |
RoleFor | long | 否 | 管理员切换成其他成员视角的用户 ID。 | 1467894xxx733152 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "E7698CFB-4E1C-5840-8EC9-691B86729E94",
"Data": {},
"Page": {
"TotalCount": 30,
"PageNumber": 1,
"PageSize": 10
}
}
错误码
访问错误中心查看更多错误码。