可以通过本接口查询历史报警记录,目前默认保存 30 天以内的报警信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListMqSofamqWarnHistory | 系统规定参数。取值:ListMqSofamqWarnHistory。 |
Cell | String | 是 | RZ00A | 目标单元 |
GroupId | String | 是 | GID_TEST | Group ID |
InstanceId | String | 是 | INSTANCE_XXX | 实例 ID |
PageNum | Long | 是 | 1 | 页码 |
PageSize | Long | 是 | 20 | 每页显示条数 |
Topic | String | 是 | TP_TEST | Topic 名称 |
WarnId | Long | 是 | 4 | 报警规则 ID |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Struct | 查询到的报警日志集合 |
|
Content | Array | 报警日志信息 |
|
Cell | String | RZ00A | 单元名称 |
GmtCreate | Long | 1570701259403 | 创建时间 |
GmtModified | Long | 1570701259403 | 修改时间 |
GroupId | String | GID_TEST | Group ID |
InstanceId | String | SOFAMQ_INSTANCE_000001 | 实例 ID |
Topic | String | TP_TEST | Topic 名称 |
WarnId | Long | 1 | 报警 ID |
WarnInfo | String | "Alert: 消息积压: 609 大于阈值: 600, 消息延时: 23478710ms 大于阈值: 10ms, " | 报警信息 |
PageNum | Long | 1 | 页码 |
PageSize | Long | 20 | 每页显示条数 |
Total | Long | 10 | 总条数 |
RequestId | String | 861E6630-AEC0-4B2D-B214-6CB5E44B7F04 | 请求ID |
ResultCode | String | OK | 结果码 |
ResultMessage | String | OK | 结果描述 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListMqSofamqWarnHistory
&Cell=RZ00A
&GroupId=GID_TEST
&InstanceId=INSTANCE_XXX
&PageNum=1
&PageSize=20
&Topic=TP_TEST
&WarnId=4
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>
<Data>
<PageNum>1</PageNum>
<PageSize>20</PageSize>
<Content>
<WarnId/>
<GmtCreate/>
<InstanceId>SOFAMQ_INSTANCE_000001</InstanceId>
<GmtModified/>
<WarnInfo>"Alert: 消息积压: 609 大于阈值: 600, 消息延时: 23478710ms 大于阈值: 10ms, "</WarnInfo>
<Topic>TP_TEST</Topic>
<Cell>RZ00A</Cell>
<GroupId>GID_TEST</GroupId>
</Content>
<Total>10</Total>
</Data>
<ResultMessage>OK</ResultMessage>
<ResultCode>OK</ResultCode>
JSON
格式
{"RequestId":"861E6630-AEC0-4B2D-B214-6CB5E44B7F04","Data":{"PageNum":"1","PageSize":"20","Content":[{"WarnId":"","GmtCreate":"","InstanceId":"SOFAMQ_INSTANCE_000001","GmtModified":"","WarnInfo":"\"Alert: 消息积压: 609 大于阈值: 600, 消息延时: 23478710ms 大于阈值: 10ms, \"","Topic":"TP_TEST","Cell":"RZ00A","GroupId":"GID_TEST"}],"Total":"10"},"ResultMessage":"OK","ResultCode":"OK"}
错误码
访问错误中心查看更多错误码。