调用 GetTopicList 获取 Topic 的列表。

调试

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

请求参数

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

要执行的动作。取值:GetTopicList

InstanceId String alikafka_pre-cn-0pp1954n2003

实例 ID。

RegionId String cn-hangzhou

地域 ID。

返回数据

名称 类型 示例值 描述
Code Integer 200

返回码。返回 200 为成功。

CurrentPage Integer 1

当前页面。

Message String operation success.

返回信息。

PageSize Integer 10000

页面大小。

RequestId String 82BD585C-17A1-486E-B3E8-AABCE8EE****

请求 ID。

Success Boolean true

调用是否成功。

TopicList

Topic 列表。

CompactTopic Boolean false

存储引擎是否为 Compact。

CreateTime Long 1566804394000

创建时间。

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

实例 ID。

LocalTopic Boolean false

Topic 的存储引擎是否为 Local。

PartitionNum Integer 12

分区数。

RegionId String cn-hangzhou

地域 ID。

Remark String kafka_test_topic

Topic 备注。

Status Integer 0

状态码。

  • 0:服务中。
  • 1:冻结。
  • 2:暂停。
StatusName String 服务中

状态描述。

Topic String poptest

Topic 名称。

Total Integer 12

Topic 总数。

示例

请求示例


http(s)://[Endpoint]/?Action=GetTopicList
&InstanceId=alikafka_pre-cn-0pp1954n2003 
&<公共请求参数>

正常返回示例

XML 格式

<TopicListResponse>
	  <TopicList>
		    <TopicVO>
			      <PartitionNum>12</PartitionNum>
			      <Status>0</Status>
			      <CompactTopic>false</CompactTopic>
			      <RegionId>cn-hangzhou</RegionId>
			      <InstanceId>alikafka_pre-cn-0pp1954n****</InstanceId>
			      <CreateTime>1567146954000</CreateTime>
			      <Topic>poptest</Topic>
			      <StatusName>服务中</StatusName>
			      <LocalTopic>false</LocalTopic>
			      <Remark>test</Remark>
		    </TopicVO>
		    <TopicVO>
			      <PartitionNum>12</PartitionNum>
			      <Status>0</Status>
			      <CompactTopic>false</CompactTopic>
			      <RegionId>cn-hangzhou</RegionId>
			      <InstanceId>alikafka_pre-cn-0pp1954n****</InstanceId>
			      <CreateTime>1566804394000</CreateTime>
			      <Topic>kafka_test_topic</Topic>
			      <StatusName>服务中</StatusName>
			      <LocalTopic>false</LocalTopic>
			      <Remark>kafka_test_topic11111111111111111111122222222222222</Remark>
		    </TopicVO>
		    <TopicVO>
			      <PartitionNum>12</PartitionNum>
			      <Status>0</Status>
			      <CompactTopic>false</CompactTopic>
			      <RegionId>cn-hangzhou</RegionId>
			      <InstanceId>alikafka_pre-cn-0pp1954n****</InstanceId>
			      <CreateTime>1566804290000</CreateTime>
			      <Topic>topic_test</Topic>
			      <StatusName>服务中</StatusName>
			      <LocalTopic>false</LocalTopic>
			      <Remark>topic_test</Remark>
		    </TopicVO>
		    <TopicVO>
			      <PartitionNum>6</PartitionNum>
			      <Status>0</Status>
			      <CompactTopic>false</CompactTopic>
			      <RegionId>cn-hangzhou</RegionId>
			      <InstanceId>alikafka_pre-cn-0pp1954n****</InstanceId>
			      <CreateTime>1565589319000</CreateTime>
			      <Topic>testkafka</Topic>
			      <StatusName>服务中</StatusName>
			      <LocalTopic>false</LocalTopic>
			      <Remark>test-data-migration</Remark>
		    </TopicVO>
		    <TopicVO>
			      <PartitionNum>45</PartitionNum>
			      <Status>0</Status>
			      <CompactTopic>false</CompactTopic>
			      <RegionId>cn-hangzhou</RegionId>
			      <InstanceId>alikafka_pre-cn-0pp1954n****</InstanceId>
			      <CreateTime>1565331243000</CreateTime>
			      <Topic>normal_topic_4fec2e97daa6f089f1a48b36b6bea34e_6</Topic>
			      <StatusName>服务中</StatusName>
			      <LocalTopic>false</LocalTopic>
			      <Remark>topic1</Remark>
		    </TopicVO>
		    <TopicVO>
			      <PartitionNum>24</PartitionNum>
			      <Status>0</Status>
			      <CompactTopic>false</CompactTopic>
			      <RegionId>cn-hangzhou</RegionId>
			      <InstanceId>alikafka_pre-cn-0pp1954n****</InstanceId>
			      <CreateTime>1565331241000</CreateTime>
			      <Topic>normal_topic_4fec2e97daa6f089f1a48b36b6bea34e_5</Topic>
			      <StatusName>服务中</StatusName>
			      <LocalTopic>false</LocalTopic>
			      <Remark>topic1</Remark>
		    </TopicVO>
	  </TopicList>
	  <Message>operation success.</Message>
	  <PageSize>10000</PageSize>
	  <RequestId>BF67619B-17C5-4FE6-BFB4-83B8C9F7****</RequestId>
	  <Success>true</Success>
	  <CurrentPage>1</CurrentPage>
	  <Code>200</Code>
	  <Total>6</Total>
</TopicListResponse>

JSON 格式

{
	"TopicList":{
		"TopicVO":[
			{
				"PartitionNum":12,
				"Status":0,
				"CompactTopic":false,
				"CreateTime":1567146954000,
				"InstanceId":"alikafka_pre-cn-0pp1954n****",
				"RegionId":"cn-hangzhou",
				"Topic":"poptest",
				"StatusName":"服务中",
				"LocalTopic":false,
				"Remark":"test"
			},
			{
				"PartitionNum":12,
				"Status":0,
				"CompactTopic":false,
				"CreateTime":1566804394000,
				"InstanceId":"alikafka_pre-cn-0pp1954n****",
				"RegionId":"cn-hangzhou",
				"Topic":"kafka_test_topic",
				"StatusName":"服务中",
				"LocalTopic":false,
				"Remark":"kafka_test_topic11111111111111111111122222222222222"
			},
			{
				"PartitionNum":12,
				"Status":0,
				"CompactTopic":false,
				"CreateTime":1566804290000,
				"InstanceId":"alikafka_pre-cn-0pp1954n****",
				"RegionId":"cn-hangzhou",
				"Topic":"topic_test",
				"StatusName":"服务中",
				"LocalTopic":false,
				"Remark":"topic_test"
			},
			{
				"PartitionNum":6,
				"Status":0,
				"CompactTopic":false,
				"CreateTime":1565589319000,
				"InstanceId":"alikafka_pre-cn-0pp1954n****",
				"RegionId":"cn-hangzhou",
				"Topic":"testkafka",
				"StatusName":"服务中",
				"LocalTopic":false,
				"Remark":"test-data-migration"
			},
			{
				"PartitionNum":45,
				"Status":0,
				"CompactTopic":false,
				"CreateTime":1565331243000,
				"InstanceId":"alikafka_pre-cn-0pp1954n****",
				"RegionId":"cn-hangzhou",
				"Topic":"normal_topic_4fec2e97daa6f089f1a48b36b6bea34e_6",
				"StatusName":"服务中",
				"LocalTopic":false,
				"Remark":"topic1"
			},
			{
				"PartitionNum":24,
				"Status":0,
				"CompactTopic":false,
				"CreateTime":1565331241000,
				"InstanceId":"alikafka_pre-cn-0pp1954n****",
				"RegionId":"cn-hangzhou",
				"Topic":"normal_topic_4fec2e97daa6f089f1a48b36b6bea34e_5",
				"StatusName":"服务中",
				"LocalTopic":false,
				"Remark":"topic1"
			}
		]
	},
	"Message":"operation success.",
	"PageSize":10000,
	"RequestId":"BF67619B-17C5-4FE6-BFB4-83B8C9F7****",
	"CurrentPage":1,
	"Success":true,
	"Code":200,
	"Total":6
}

错误码

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