查询IM机器人列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RobotName |
string |
否 |
IM 机器人名称。 |
robot名称 |
| Page |
integer |
是 |
查询页数。 |
1 |
| Size |
integer |
是 |
每页展示的 IM 机器人数。 |
20 |
| RobotIds |
string |
否 |
机器人 ID 列表。 |
123 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
4D6C358A-A58B-4F4B-94CE-F5AAF023**** |
| PageBean |
object |
分页对象。 |
|
| Total |
integer |
查询到的 IM 机器人总数。 |
1 |
| Page |
integer |
查询的页数。 |
1 |
| Size |
integer |
每页的 IM 机器人数。 |
20 |
| AlertIMRobots |
array<object> |
IM 机器人详情。 |
|
|
array<object> |
|||
| RobotId |
number |
IM 机器人 ID。 |
123 |
| Type |
string |
IM 机器人类型：
|
dingding |
| RobotName |
string |
IM 机器人名称。 |
robot名称 |
| RobotAddr |
string |
IM 机器人的 Webhook 地址。 |
https://oapi.dingtalk.com/robot/send?access_token=e1a049121****** |
| DailyNoc |
boolean |
是否发送每日统计信息。
|
true |
| DailyNocTime |
string |
每日统计信息发送的时间点。ARMS 告警管理将在设置的时间点发送今日产生告警的总数、解决数和待解决数。 |
09:30,17:30 |
| DingSignKey |
string |
钉钉签名密钥。如配置了密钥则会通过加签的方式进行钉钉认证。如果没有配置密钥，默认使用关键字白名单的方式进行认证，白名单关键字为告警。 |
****** |
| CreateTime |
string |
IM 机器人的创建时间。 |
2023-01-16 17:21:48 |
| DispatchRules |
array<object> |
通知策略。 |
|
|
object |
|||
| id |
integer |
通知策略 ID。 |
12345 |
| name |
string |
通知策略名称。 |
通知策略测试 |
示例
正常返回示例
JSON格式
{
"RequestId": "4D6C358A-A58B-4F4B-94CE-F5AAF023****",
"PageBean": {
"Total": 1,
"Page": 1,
"Size": 20,
"AlertIMRobots": [
{
"RobotId": 123,
"Type": "dingding",
"RobotName": "robot名称",
"RobotAddr": "https://oapi.dingtalk.com/robot/send?access_token=e1a049121******",
"DailyNoc": true,
"DailyNocTime": "09:30,17:30",
"DingSignKey": "******",
"CreateTime": "2023-01-16 17:21:48",
"DispatchRules": [
{
"id": 12345,
"name": "通知策略测试"
}
]
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。