全部产品
Search
文档中心

消息队列Kafka版:GetTopicStatus - 获取消息收发状态

更新时间:Nov 22, 2022

调用GetTopicStatus获取Topic的消息收发状态。

调试

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

调试

授权信息

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

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

请求参数

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

实例ID。

alikafka_pre-cn-v0h15tjm****
Topicstring

Topic名称。

normal_topic_9d034262835916103455551be06cc****
RegionIdstring

地域ID。

cn-hangzhou

返回参数

名称类型描述示例值
object
Codeinteger

状态码。返回200代表成功。

200
Messagestring

返回信息。

operation success.
RequestIdstring

请求ID。

E475C7E2-8C35-46EF-BE7D-5D2A9F5D****
Successboolean

调用是否成功。

true
TopicStatusobject

Topic状态。

TotalCountlong

消息总数。

423
LastTimeStamplong

最后一条被消费的消息的产生时间。单位:ms。

1566470063575
OffsetTablearray

偏移列表。

object
Partitioninteger

分区ID。

0
MinOffsetlong

消息最小位点。

0
LastUpdateTimestamplong

最后更新时间。单位:ms。

1566470063547
MaxOffsetlong

消息最大位点。

76
Topicstring

Topic名称。

testkafka

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "E475C7E2-8C35-46EF-BE7D-5D2A9F5D****",
  "Success": true,
  "TopicStatus": {
    "TotalCount": 423,
    "LastTimeStamp": 1566470063575,
    "OffsetTable": [
      {
        "Partition": 0,
        "MinOffset": 0,
        "LastUpdateTimestamp": 1566470063547,
        "MaxOffset": 76,
        "Topic": "testkafka"
      }
    ]
  }
}

错误码

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