调用GetTopicList获取Topic信息。

调试

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

请求参数

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

要执行的操作。取值:GetTopicList

InstanceId String alikafka_pre-cn-0pp1954n****

Topic所属实例的ID。

CurrentPage String 1

当前页码。

PageSize String 10

分页大小。

RegionId String cn-hangzhou

Topic所属实例的地域ID。

Topic String topic_name

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

返回数据

名称 类型 示例值 描述
CurrentPage Integer 1

当前页码。

RequestId String C0D3DC5B-5C37-47AD-9F22-1F5598809***

请求ID。

Success Boolean true

调用是否成功。

Code Integer 200

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

Message String operation success.

返回信息。

PageSize Integer 10

页大小。

Total Integer 1

Topic总数。

TopicList Array of TopicVO

Topic详情。

TopicVO
Status Integer 0

服务状态。取值:

0:服务中。

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

PartitionNum Integer 6

Topic的分区数量。

Remark String test

备注。取值:

  • 只能包含字母、数字、下划线(_)和短划线(-)。
  • 长度为3~64字符。
CreateTime Long 1576563109000

创建时间。

Topic String topic_name

Topic名称。取值:

  • 只能包含字母、数字、下划线(_)和短划线(-)。
  • 限制在3~64字符,长于64字符将被自动截取。
StatusName String 服务中

服务状态名称。取值:

服务中

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

CompactTopic Boolean false

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

  • false:delete清理策略。
  • true:compact清理策略。
InstanceId String alikafka_pre-cn-0pp1954n****

实例ID。

LocalTopic Boolean false

Topic的存储引擎。取值:

  • false:云存储。
  • true:Local存储。
RegionId String cn-hangzhou

Topic所属实例的地域ID。

Tags Array of TagVO

标签。

TagVO
Key String Test

标签键。

Value String Test

标签值。

示例

请求示例

http(s)://alikafka.cn-hangzhou.aliyuncs.com/?Action=GetTopicList
&InstanceId=alikafka_pre-cn-0pp1954n****
&CurrentPage=1
&PageSize=10
&RegionId=cn-hangzhou
&Topic=topic_name
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetTopicListResponse>
    <CurrentPage>1</CurrentPage>
    <RequestId>C0D3DC5B-5C37-47AD-9F22-1F5598809***</RequestId>
    <Success>true</Success>
    <Code>200</Code>
    <Message>operation success.</Message>
    <PageSize>10</PageSize>
    <Total>1</Total>
    <TopicList>
        <Status>0</Status>
        <PartitionNum>6</PartitionNum>
        <Remark>test</Remark>
        <CreateTime>1576563109000</CreateTime>
        <Topic>topic_name</Topic>
        <StatusName>服务中</StatusName>
        <CompactTopic>false</CompactTopic>
        <InstanceId>alikafka_pre-cn-0pp1954n****</InstanceId>
        <LocalTopic>false</LocalTopic>
        <RegionId>cn-hangzhou</RegionId>
        <Tags>
            <Key>Test</Key>
            <Value>Test</Value>
        </Tags>
    </TopicList>
</GetTopicListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "CurrentPage" : 1,
  "RequestId" : "C0D3DC5B-5C37-47AD-9F22-1F5598809***",
  "Success" : true,
  "Code" : 200,
  "Message" : "operation success.",
  "PageSize" : 10,
  "Total" : 1,
  "TopicList" : [ {
    "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" : [ {
      "Key" : "Test",
      "Value" : "Test"
    } ]
  } ]
}

错误码

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