CreateOrUpdateIMRobot
创建或更新IM机器人
服务地址：
华东1 金融云
输入参数
只看必填
RobotIdIM机器人ID
RobotNameIM机器人名称
TypeIM机器人类型：
RobotAddressIM机器人的Webhook地址
DailyNoc是否发送每日统计信息
请选择布尔值
DailyNocTime每日统计信息发送的时间点
DingSignKey钉钉签名密钥
Token开启Outgoing机制需要的Token
EnableOutgoing是否开启Outgoing机制
请选择布尔值
CardTemplate告警卡片模版配置信息
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

请求参数

字段名称字段详情
RobotIdinteger<int64>

IM 机器人 ID。展开详情

注意 该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。
示例值:123参考取值来源:
    DescribeIMRobots
RobotNamestring

IM 机器人名称。

示例值:robot名称参考取值来源:
    DescribeIMRobots
Typestring

IM 机器人类型：展开详情

示例值:dingding
RobotAddressstring

IM 机器人的 Webhook 地址。

示例值:https://oapi.dingtalk.com/robot/send?access_token=e1a049121******参考取值来源:
    DescribeIMRobots
DailyNocboolean

是否发送每日统计信息。展开详情

示例值:true
DailyNocTimestring

每日统计信息发送的时间点，使用半角逗号（,）分隔多个发送时间点，时间点格式为 HH:SS。ARMS 告警管理将在设置的时间点发送今日产生告警的总数、解决数和待解决数。

示例值:09:30,17:00
DingSignKeystring

钉钉签名密钥。如配置了密钥则会通过加签的方式进行钉钉认证。如果没有配置密钥，默认使用关键字白名单的方式进行认证，白名单关键字为告警。展开详情

示例值:******
Tokenstring

开启 Outgoing 机制需要的 Token。

示例值:1656558719183be1245ab44********
EnableOutgoingboolean

是否开启 Outgoing 机制。

示例值:true
CardTemplatestring

告警卡片模版配置信息。模板中各参数含义请参见下方补充说明。

示例值:{ "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：未解决告警按钮

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:16AF921B-8187-489F-9913-43C808B4****
AlertRobotobject

返回 AlertRobot 对象。

变更历史
暂无变更历史