文档

OnsTopicStatus - 查询Topic状态

更新时间:
一键部署

查询当前Topic下的消息总量以及Topic的状态。

接口说明

注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。
本接口一般用于判断 Topic 资源的使用率。调用本接口后返回的信息包含当前服务器上该 Topic 所有的消息数,以及最后消息写入时间。

调试

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

授权信息

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

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

请求参数

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

需查询的 Topic 名称。

test
InstanceIdstring

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

MQ_INST_188077086902****_BXSuW61e

返回参数

名称类型描述示例值
object

返回信息。

RequestIdstring

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

427EE49D-D762-41FB-8F3D-9BAC96C3****
Dataobject

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

Perminteger

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

  • 2:可以发布
  • 4:可以订阅
  • 6:可以发布和订阅
6
LastTimeStamplong

当前 Topic 内最新一条消息的就绪时间,如果 Topic 内没有消息,则该参数返回值为 0。

该参数值的格式为毫秒级 Unix 时间戳。

就绪消息及就绪时间具体含义,请参见名词解释

1570864984364
TotalCountlong

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

2310

示例

正常返回示例

JSON格式

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

错误码

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

  • 本页导读 (1)
文档反馈