GetTopicList - 获取Topic信息

调用GetTopicList获取Topic信息。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

Topic所属实例的ID。

alikafka_pre-cn-0pp1954n****
CurrentPagestring

当前页码。

1
PageSizestring

分页大小。

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
TopicListarray

Topic详情。

object
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
Tagsarray

标签。

object
Keystring

标签键。

Test
Valuestring

标签值。

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
&公共请求参数

正常返回示例

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"
                }
            ]
        }
    ]
}

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>

错误码

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

变更历史

变更时间变更内容概要操作
2021-11-22OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Topic
阿里云首页 消息队列Kafka版 相关技术圈