文档

GetTopicList - 获取Topic信息

更新时间:

获取Topic信息。

调试

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

授权信息

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

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

请求参数

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

Topic 所属实例的 ID。

alikafka_pre-cn-0pp1954n****
CurrentPagestring

当前页码。默认值:1。

1
PageSizestring

分页大小。默认值:10。

10
RegionIdstring

Topic 所属实例的地域 ID。

cn-hangzhou
Topicstring

获取指定 Topic 信息的 Topic 名称。

topic_name

返回参数

名称类型描述示例值
object
CurrentPageinteger

当前页码。

1
RequestIdstring

请求 ID。

C0D3DC5B-5C37-47AD-9F22-1F559880****
Successboolean

调用是否成功。

true
Codeinteger

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

200
Messagestring

返回信息。

operation success.
PageSizeinteger

页大小。

10
Totalinteger

Topic 总数。

1
TopicListobject []

Topic 详情。

Statusinteger

服务状态。取值:

0:服务中。

删除 Topic,则 Topic 无服务状态。

0
PartitionNuminteger

Topic 的分区数量。

6
Remarkstring

备注。取值:

  • 只能包含字母、数字、下划线(_)和短划线(-)。

  • 长度为 3~64 字符。

test
CreateTimelong

创建时间戳。单位:毫秒

1576563109000
Topicstring

Topic 名称。取值:

  • 只能包含字母、数字、下划线(_)和短划线(-)。

  • 限制在 3~64 字符,长于 64 字符将被自动截取。

topic_name
StatusNamestring

服务状态名称。取值:

服务中

删除 Topic,则 Topic 无服务状态名称。

服务中
CompactTopicboolean

LocalTopic 配置为 true 时,会配置日志清理策略。取值:

  • false:delete 清理策略。

  • true:compact 清理策略。

false
InstanceIdstring

实例 ID。

alikafka_pre-cn-0pp1954n****
LocalTopicboolean

Topic 的存储引擎。取值:

  • false:云存储。

  • true:Local 存储。

false
RegionIdstring

Topic 所属实例的地域 ID。

cn-hangzhou
Tagsobject []

标签。

Keystring

标签键。

Test
Valuestring

标签值。

Test
AutoCreateboolean

标识 Topic 是否为自动创建。

false

示例

正常返回示例

JSON格式

{
  "CurrentPage": 1,
  "RequestId": "C0D3DC5B-5C37-47AD-9F22-1F559880****",
  "Success": true,
  "Code": 200,
  "Message": "operation success.",
  "PageSize": 10,
  "Total": 1,
  "TopicList": {
    "TopicVO": [
      {
        "Status": 0,
        "PartitionNum": 6,
        "Remark": "test",
        "CreateTime": 1576563109000,
        "Topic": "topic_name",
        "StatusName": "服务中",
        "CompactTopic": false,
        "InstanceId": "alikafka_pre-cn-0pp1954n****",
        "LocalTopic": false,
        "RegionId": "cn-hangzhou",
        "Tags": {
          "TagVO": [
            {
              "Key": "Test",
              "Value": "Test"
            }
          ]
        },
        "AutoCreate": false
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2021-11-22OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Topic
  • 本页导读 (1)
文档反馈