CreateOrUpdateIMRobot - 建立或更新IM機器人 - Application Real-Time Monitoring Service

建立或更新IM機器人。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
RobotId	integer	否	IM 機器人 ID。不填代表建立新的 IM 機器人。填寫代表修改指定 IM 機器人資訊。	123
RobotName	string	是	IM 機器人名稱。	robot名稱
Type	string	是	IM 機器人類型： `dingding`：DingTalk機器人。 `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	否	DingTalk簽名密鑰。如配置了密鑰則會通過加簽的方式進行DingTalk認證。如果沒有配置密鑰，預設使用關鍵字白名單的方式進行認證，白名單關鍵字為警示。	******
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`：DingTalk機器人。 `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         }     ] }"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。