获取报警规则列表信息。

调试

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

请求参数

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

系统规定参数。取值:ListMqSofamqWarn。

GroupId String GID_group

查询指定 Group 的报警规则时设置

InstanceId String MQ_INST_111111111111_DOxxxxxx

实例 ID

PageNum Long 1

页码

PageSize Long 20

每页显示条数

Topic String test

查询指定 Topic 的报警规则时设置

返回数据

名称 类型 示例值 描述
Data Struct

查询到的告警规则集合

Content Array

报警规则信息

AlertTime String 00:00-23:59

报警时间段

Attribute String ""

属性字符串

BlockTime Long 10

消息阻塞时间

Contacts String [["DingTalk", "机器人令牌", "组名"], ["DingTalk", "机器人令牌2", "组名2"]]

联系人列表

DelayTime Long 5

延迟时间

Frequency Long 10

报警频率,单位分钟

GmtCreate Long 1570701259403

创建时间

GmtModified Long 1570701259403

修改时间

GroupId String GID_TEST

消费组 ID

Id Long 1

报警 ID

InstanceId String SOFAMQ_INSTANCE_000001

实例 ID

Operator String alipay

操作者

Threshold Long 3000

阈值

Topic String TP_TEST

报警的 Topic

WarnLevel Long 5

报警级别

WarnStatus Long 1

报警状态

WarnType Long 1

报警类型

PageNum Long 1

页码

PageSize Long 20

每页显示条数

Total Long 100

总条数

RequestId String 861E6630-AEC0-4B2D-B214-6CB5E44B7F04

请求ID

ResultCode String OK

结果码

ResultMessage String OK

结果描述

示例

请求示例

http(s)://[Endpoint]/?Action=ListMqSofamqWarn
&GroupId=GID_group
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&PageNum=1
&PageSize=20
&Topic=test
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>
<Data>
    <PageNum>1</PageNum>
    <PageSize>20</PageSize>
    <Content>
        <Operator>alipay</Operator>
        <WarnType>1</WarnType>
        <Attribute>""</Attribute>
        <InstanceId>SOFAMQ_INSTANCE_000001</InstanceId>
        <BlockTime>10</BlockTime>
        <GmtModified>1570701259403</GmtModified>
        <DelayTime>5</DelayTime>
        <AlertTime>00:00-23:59</AlertTime>
        <GroupId>GID_TEST</GroupId>
        <WarnStatus>1</WarnStatus>
        <GmtCreate>1570701259403</GmtCreate>
        <WarnLevel>5</WarnLevel>
        <Contacts>[["DingTalk", "机器人令牌", "组名"], ["DingTalk", "机器人令牌2", "组名2"]]</Contacts>
        <Frequency>10</Frequency>
        <Id>1</Id>
        <Topic>TP_TEST</Topic>
        <Threshold>3000</Threshold>
    </Content>
    <Total>100</Total>
</Data>
<ResultMessage>OK</ResultMessage>
<ResultCode>OK</ResultCode>

JSON 格式

{"RequestId":"861E6630-AEC0-4B2D-B214-6CB5E44B7F04","Data":{"PageNum":"1","PageSize":"20","Content":[{"Operator":"alipay","WarnType":"1","Attribute":"\"\"","InstanceId":"SOFAMQ_INSTANCE_000001","BlockTime":"10","GmtModified":"1570701259403","DelayTime":"5","AlertTime":"00:00-23:59","GroupId":"GID_TEST","WarnStatus":"1","GmtCreate":"1570701259403","WarnLevel":"5","Contacts":"[[\"DingTalk\", \"机器人令牌\", \"组名\"], [\"DingTalk\", \"机器人令牌2\", \"组名2\"]]","Frequency":"10","Id":"1","Topic":"TP_TEST","Threshold":"3000"}],"Total":"100"},"ResultMessage":"OK","ResultCode":"OK"}

错误码

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