调用CreateOrUpdateIMRobot接口创建或更新IM机器人。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateOrUpdateIMRobot

系统规定参数。取值:CreateOrUpdateIMRobot

RobotId Long 123

IM机器人ID。

  • 不填代表创建新的IM机器人。
  • 填写代表修改指定IM机器人信息。
RobotName String robot名称

IM机器人名称。

Type String dingding

IM机器人类型:

  • dingding:钉钉机器人。
  • wechat:企业微信机器人。
RobotAddress String https://oapi.dingtalk.com/robot/send?access_token=e1a049121******

IM机器人的Webhook地址。

DailyNoc Boolean true

是否发送每日统计信息。

  • false(默认):不发送统计信息。
  • true:发送统计信息。选择true后,DailyNocTime参数必填。
DailyNocTime String 09:30,17:00

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

返回数据

名称 类型 示例值 描述
RequestId String 16AF921B-8187-489F-9913-43C808B4****

请求ID。

AlertRobot Object

返回AlertRobot对象。

RobotId Float 123

IM机器人ID。

RobotName String robot名称

IM机器人名称。

Type String dingding

IM机器人类型:

  • dingding:钉钉机器人。
  • wechat:企业微信机器人。
RobotAddress String https://oapi.dingtalk.com/robot/send?access_token=e1a049121******

IM机器人的Webhook地址。

DailyNoc Boolean true

是否发送每日统计信息。

  • false(默认):不发送统计信息。
  • true:发送统计信息。
DailyNocTime String 09:30,17:00

每日统计信息发送的时间点。ARMS告警管理将在设置的时间点发送今日产生告警的总数、解决数和待解决数。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateOrUpdateIMRobot
&RobotId=123
&RobotName=robot名称
&Type=dingding
&RobotAddress=https://oapi.dingtalk.com/robot/send?access_token=e1a049121******
&DailyNoc=true
&DailyNocTime=09:30,17:00
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateOrUpdateIMRobotResponse>
    <RequestId>16AF921B-8187-489F-9913-43C808B4****</RequestId>
    <AlertRobot>
        <RobotId>123</RobotId>
        <RobotName>robot名称</RobotName>
        <Type>dingding</Type>
        <RobotAddress>https://oapi.dingtalk.com/robot/send?access_token=e1a049121******</RobotAddress>
        <DailyNoc>true</DailyNoc>
        <DailyNocTime>09:30,17:00</DailyNocTime>
    </AlertRobot>
</CreateOrUpdateIMRobotResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
  }
}