DescribeIMRobots - 查询IM机器人列表 - 应用实时监控服务ARMS

查询IM机器人列表。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
arms:SearchContact	none	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RobotName	string	否	IM 机器人名称。	robot名称
Page	long	是	查询页数。	1
Size	long	是	每页展示的 IM 机器人数。	20
RobotIds	string	否	机器人 ID 列表。	123

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	4D6C358A-A58B-4F4B-94CE-F5AAF023****
PageBean	object	分页对象。
Total	long	查询到的 IM 机器人总数。	1
Page	long	查询的页数。	1
Size	long	每页的 IM 机器人数。	20
AlertIMRobots	array<object>	IM 机器人详情。
IMRobots	object
RobotId	float	IM 机器人 ID。	123
Type	string	IM 机器人类型： `dingding`：钉钉机器人。 `wechat`：企业微信机器人。	dingding
RobotName	string	IM 机器人名称。	robot名称
RobotAddr	string	IM 机器人的 Webhook 地址。	https://oapi.dingtalk.com/robot/send?access_token=e1a049121******
DailyNoc	boolean	是否发送每日统计信息。 `false`（默认）：不发送统计信息。 `true`：发送统计信息。	true
DailyNocTime	string	每日统计信息发送的时间点。ARMS 告警管理将在设置的时间点发送今日产生告警的总数、解决数和待解决数。	09:30,17:30
DingSignKey	string	钉钉签名密钥。如配置了密钥则会通过加签的方式进行钉钉认证。如果没有配置密钥，默认使用关键字白名单的方式进行认证，白名单关键字为告警。	******
CreateTime	string	IM 机器人的创建时间。	2023-01-16 17:21:48
DispatchRules	array<object>	通知策略。
DispatchRule	object
id	long	通知策略 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": "通知策略测试"
          }
        ]
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-05-09	API 内部配置变更，不影响调用	查看变更详情