调用OnsTopicStatus接口查询当前Topic下的消息总量以及Topic的最后更新时间。

使用说明

本接口一般用于判断Topic资源的使用率。调用本接口后返回的信息包含当前服务器上该Topic所有的消息数,以及最后消息写入时间。

QPS限制

本接口的单用户QPS限制为1次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

授权信息

默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息,请参见权限策略和示例

API

Action

Resource(有命名空间)

Resource(无命名空间)

OnsTopicStatus

mq:QueryTopicStatus

acs:mq:*:*:{instanceId}%{topic}

acs:mq:*:*:{topic}

请求参数

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

系统规定参数。取值:OnsTopicStatus

InstanceId String MQ_INST_188077086902****_BXSuW61e

需查询的Topic所对应的实例ID。

Topic String test

需查询的Topic名称。

返回数据

名称 类型 示例值 描述
Data Struct

查询到的Topic的信息存储数据结构。

LastTimeStamp Long 1570864984364

当前Topic的最后更新时间。

Perm Integer 6

所有关系编号。取值说明如下:

  • 2:可以发布
  • 4:可以订阅
  • 6:可以发布和订阅
TotalCount Long 2310

当前Topic的所有分区存在的消息数总和。

RequestId String 427EE49D-D762-41FB-8F3D-9BAC96C3****

公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。

示例

请求示例

http(s)://ons.cn-zhangjiakou.aliyuncs.com/?Action=OnsTopicStatus
&InstanceId=MQ_INST_188077086902****_BXSuW61e
&Topic=test
&<公共请求参数>

正常返回示例

XML格式

<OnsTopicStatusResponse>
  <Data>
        <Perm>6</Perm>
        <TotalCount>2310</TotalCount>
        <LastTimeStamp>1570864984364</LastTimeStamp>
  </Data>
  <RequestId>427EE49D-D762-41FB-8F3D-9BAC96C3****</RequestId>
</OnsTopicStatusResponse>

JSON格式

{
	"Data": {
		"Perm": 6,
		"TotalCount": 2310,
		"LastTimeStamp": 1570864984364
	},
	"RequestId": "427EE49D-D762-41FB-8F3D-9BAC96C3****"
}

错误码

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