文档

DescribeIMRobots - 查询IM机器人列表

更新时间:

查询IM机器人列表。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
RobotNamestring

IM 机器人名称。

robot名称
Pagelong

查询页数。

1
Sizelong

每页展示的 IM 机器人数。

20
RobotIdsstring

机器人 ID 列表。

123

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

4D6C358A-A58B-4F4B-94CE-F5AAF023****
PageBeanobject

分页对象。

Totallong

查询到的 IM 机器人总数。

1
Pagelong

查询的页数。

1
Sizelong

每页的 IM 机器人数。

20
AlertIMRobotsobject []

IM 机器人详情。

RobotIdfloat

IM 机器人 ID。

123
Typestring

IM 机器人类型:

  • dingding:钉钉机器人。
  • wechat:企业微信机器人。
dingding
RobotNamestring

IM 机器人名称。

robot名称
RobotAddrstring

IM 机器人的 Webhook 地址。

https://oapi.dingtalk.com/robot/send?access_token=e1a049121******
DailyNocboolean

是否发送每日统计信息。

  • false(默认):不发送统计信息。
  • true:发送统计信息。
true
DailyNocTimestring

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

09:30,17:30
DingSignKeystring

钉钉签名密钥。如配置了密钥则会通过加签的方式进行钉钉认证。如果没有配置密钥,默认使用关键字白名单的方式进行认证,白名单关键字为告警。 更多信息,请参见钉钉官方文档

******
CreateTimestring

IM 机器人的创建时间。

2023-01-16 17:21:48
DispatchRulesobject []

通知策略。

idlong

通知策略 ID。

12345
namestring

通知策略名称。

通知策略测试

示例

正常返回示例

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": "通知策略测试"
          }
        ]
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈