跳转至

创建一个通知对象



POST /api/v1/notify_object/create

概述

创建一个通知对象

Body 请求参数

参数名 类型 必选 说明
type string Y 触发规则类型, 默认为trigger
允许为空: True
可选值: ['dingTalkRobot', 'HTTPRequest', 'wechatRobot', 'mailGroup', 'feishuRobot', 'sms', 'simpleHTTPRequest']
name string Y 通知对象名字
允许为空: False
optSet json 告警设置
允许为空: False
permissionSet array 操作权限配置, 可配置(角色(除拥有者), 成员uuid, 团队uuid)
例子: ['wsAdmin', 'acnt_xxxx', 'group_yyyy']
允许为空: False

参数补充说明

数据说明.

**1. type=dingTalkRobot optSet的参数 **

key 类型 是否必须 说明
webhook String 必须 钉钉机器⼈调⽤地址
secret String 必须 钉钉机器⼈调⽤密钥(添加机器⼈-安全设置-加签)

**2. type=HTTPRequest 时,optSet的参数 **

key 类型 是否必须 说明
url String 必须 HTTP 调⽤地址

**3. type=wechatRobot 时,optSet的参数 **

key 类型 是否必须 说明
webhook String 必须 机器⼈调⽤地址

**4. type=mailGroup 时,optSet的参数 **

key 类型 是否必须 说明
to Array 必须 成员账号列表

**5. type=feishuRobot optSet的参数 **

key 类型 是否必须 说明
webhook String 必须 飞书机器⼈调⽤地址
secret String 必须 飞书机器⼈调⽤密钥(添加机器⼈-安全设置-加签)

**6. type=sms 时,optSet的参数 **

key 类型 是否必须 说明
to Array 必须 手机号码列表

**7. type=simpleHTTPRequest 时,optSet的参数 **

key 类型 是否必须 说明
url String 必须 HTTP 调⽤地址

**permissionSet 字段说明(2024-06-26迭代新增字段): ** 通知对象的 新增/修改 新增 permissionSet 列表字段的配置, 只有属于配置中的 角色, 团队, 成员才能进行编辑/删除, 如果未配置该字段或配置为[], 则删除/编辑权限走原有接口编辑/删除权限

permissionSet 字段可配置, 角色(wsAdmin, general, readOnly, role_xxxxx ), 团队(group_yyyy), 成员(acnt_xxx) permissionSet 字段示例:

  ["wsAdmin", "general", "group_yyyy", "acnt_xxxx"]

响应


文档评价

文档内容是否对您有帮助? ×