CreateOrUpdateIMRobot - 创建或更新IM机器人 - 应用实时监控服务ARMS

创建或更新IM机器人。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RobotId	integer	否	IM 机器人 ID。不填代表创建新的 IM 机器人。填写代表修改指定 IM 机器人信息。	123
RobotName	string	是	IM 机器人名称。	robot名称
Type	string	是	IM 机器人类型： `dingding`：钉钉机器人。 `wechat`：企业微信机器人。 `feishu`：飞书机器人。	dingding
RobotAddress	string	是	IM 机器人的 Webhook 地址。	https://oapi.dingtalk.com/robot/send?access_token=e1a049121******
DailyNoc	boolean	否	是否发送每日统计信息。 `false`（默认）：不发送统计信息。 `true`：发送统计信息。选择`true`后，DailyNocTime 参数必填。	true
DailyNocTime	string	否	每日统计信息发送的时间点，使用半角逗号（,）分隔多个发送时间点，时间点格式为 HH:SS。ARMS 告警管理将在设置的时间点发送今日产生告警的总数、解决数和待解决数。	09:30,17:00
DingSignKey	string	否	钉钉签名密钥。如配置了密钥则会通过加签的方式进行钉钉认证。如果没有配置密钥，默认使用关键字白名单的方式进行认证，白名单关键字为告警。	******
Token	string	否	开启 Outgoing 机制需要的 Token。	1656558719183be1245ab44********
EnableOutgoing	boolean	否	是否开启 Outgoing 机制。	true
CardTemplate	string	否	告警卡片模版配置信息。模板中各参数含义请参见下方补充说明。	{ "button": [ "claim", "close", "follow", "send_itsm", "block", "unResolvedIncident" ], "field": [ { "fieldName": "alarmName", "visible": true }, { "fieldName": "notificationPolicy", "visible": true }, { "fieldName": "alarmContent", "visible": true }, { "fieldName": "alarmTime", "visible": true }, { "fieldName": "seriesChart", "visible": true }, { "fieldName": "includeEvent", "visible": true }, { "fieldName": "assigned", "visible": true }, { "fieldName": "similarAlarm", "visible": true }, { "fieldName": "operator", "visible": true } ] }

CardTemplate 参数说明

模板示例：

{
    "field": [
        {
            "fieldName": "alarmName",
            "visible": false
        },
        {
            "fieldName": "notificationPolicy",
            "visible": true
        },
        {
            "fieldName": "alarmContent",
            "visible": true
        },
        {
            "fieldName": "alarmTime",
            "visible": true
        },
        {
            "fieldName": "seriesChart",
            "visible": true
        },
        {
            "fieldName": "includeEvent",
            "visible": true
        },
        {
            "fieldName": "assigned",
            "visible": true
        },
        {
            "fieldName": "similarAlarm",
            "visible": true
        },
        {
            "fieldName": "operator",
            "visible": true
        }
    ],
    "button": [
        "claim",
        "close",
        "block",
        "send_itsm",
        "unResolvedIncident",
        "follow"
    ]
}

fieldName：告警卡片中的字段名称。包含字段如下：
- notificationPolicy：通知策略
- alarmName：告警名称
- alarmContent：告警内容
- alarmTime：告警时间
- includeEvent：包含事件的数量
- assigned：通知人
- operator：告警处理人
- similarAlarm：上次相似告警
- seriesChart：告警指标趋势图
visible：发送的告警卡片上对应字段内容是否可见。
- true：可见
- false：隐藏
button：卡片中的设置按钮，参数顺序对应卡片按钮顺序。按钮有以下几种：
- claim：认领告警按钮
- close：解决告警按钮
- follow：关注告警按钮
- send_itsm：推送告警按钮
- block：屏蔽告警按钮
- unResolvedIncident：未解决告警按钮

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	16AF921B-8187-489F-9913-43C808B4****
AlertRobot	object	返回 AlertRobot 对象。
RobotId	number	IM 机器人 ID。填写该参数代表修改机器人信息。	123
RobotName	string	IM 机器人名称。	robot名称
Type	string	IM 机器人类型： `dingding`：钉钉机器人。 `wechat`：企业微信机器人。	dingding
RobotAddress	string	IM 机器人的 Webhook 地址。	https://oapi.dingtalk.com/robot/send?access_token=e1a049121******
DailyNoc	boolean	是否发送每日统计信息。 `false`（默认）：不发送统计信息。 `true`：发送统计信息。	true
DailyNocTime	string	每日统计信息发送的时间点。ARMS 告警管理将在设置的时间点发送今日产生告警的总数、解决数和待解决数。	09:30,17:00
Token	string	开启 Outgoing 机制需要的 Token。	1656558719183be1245ab44********
EnableOutgoing	boolean	是否开启 Outgoing 机制。	true
CardTemplate	string	告警卡片模版配置信息。	{ "button": [ "claim", "close", "follow", "send_itsm", "block", "unResolvedIncident" ], "field": [ { "fieldName": "alarmName", "visible": true }, { "fieldName": "notificationPolicy", "visible": true }, { "fieldName": "alarmContent", "visible": true }, { "fieldName": "alarmTime", "visible": true }, { "fieldName": "seriesChart", "visible": true }, { "fieldName": "includeEvent", "visible": true }, { "fieldName": "assigned", "visible": true }, { "fieldName": "similarAlarm", "visible": true }, { "fieldName": "operator", "visible": true } ] }

示例

正常返回示例

JSON格式

{
  "RequestId": "16AF921B-8187-489F-9913-43C808B4****",
  "AlertRobot": {
    "RobotId": 123,
    "RobotName": "robot名称",
    "Type": "dingding",
    "RobotAddress": "https://oapi.dingtalk.com/robot/send?access_token=e1a049121******",
    "DailyNoc": true,
    "DailyNocTime": "09:30,17:00",
    "Token": "1656558719183be1245ab44********\n",
    "EnableOutgoing": true,
    "CardTemplate": "{     \"button\": [         \"claim\",         \"close\",         \"follow\",         \"send_itsm\",         \"block\",         \"unResolvedIncident\"     ],     \"field\": [         {             \"fieldName\": \"alarmName\",             \"visible\": true         },         {             \"fieldName\": \"notificationPolicy\",             \"visible\": true         },         {             \"fieldName\": \"alarmContent\",             \"visible\": true         },         {             \"fieldName\": \"alarmTime\",             \"visible\": true         },         {             \"fieldName\": \"seriesChart\",             \"visible\": true         },         {             \"fieldName\": \"includeEvent\",             \"visible\": true         },         {             \"fieldName\": \"assigned\",             \"visible\": true         },         {             \"fieldName\": \"similarAlarm\",             \"visible\": true         },         {             \"fieldName\": \"operator\",             \"visible\": true         }     ] }"
  }
}

错误码

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

变更历史

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