调用DescribeIMRobots接口查询IM机器人列表。

调试

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

请求参数

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

系统规定参数。取值:DescribeIMRobots

RobotName String robot名称

IM机器人名称。

Page Long 1

查询页数。

Size Long 20

每页展示的IM机器人数。

返回数据

名称 类型 示例值 描述
RequestId String 4D6C358A-A58B-4F4B-94CE-F5AAF023****

请求ID。

PageBean Object

分页对象。

Total Long 1

查询到的IM机器人总数。

Page Long 1

查询的页数。

Size Long 20

每页的IM机器人数。

AlertIMRobots Array of IMRobots

IM机器人详情。

RobotId Float 123

IM机器人ID。

Type String dingding

IM机器人类型:

  • dingding:钉钉机器人。
  • wechat:企业微信机器人。
RobotName String robot名称

IM机器人名称。

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

IM机器人的Webhook地址。

DailyNoc Boolean true

是否发送每日统计信息。

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

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeIMRobots
&RobotName=robot名称
&Page=1
&Size=20
&公共请求参数

正常返回示例

XML格式

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

<DescribeIMRobotsResponse>
    <RequestId>4D6C358A-A58B-4F4B-94CE-F5AAF023****</RequestId>
    <PageBean>
        <Total>1</Total>
        <Page>1</Page>
        <Size>20</Size>
        <AlertIMRobots>
            <RobotId>123</RobotId>
            <Type>dingding</Type>
            <RobotName>robot名称</RobotName>
            <RobotAddr>https://oapi.dingtalk.com/robot/send?access_token=e1a049121******</RobotAddr>
            <DailyNoc>true</DailyNoc>
            <DailyNocTime>09:30,17:30</DailyNocTime>
        </AlertIMRobots>
    </PageBean>
</DescribeIMRobotsResponse>

JSON格式

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