获取Topic信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
alikafka:ListTopic | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | Topic所属实例的ID。 | alikafka_pre-cn-0pp1954n**** |
CurrentPage | string | 否 | 当前页码。默认值:1。 | 1 |
PageSize | string | 否 | 分页大小。默认值:10。 | 10 |
RegionId | string | 否 | Topic所属实例的地域ID。 | cn-hangzhou |
Topic | string | 否 | 获取指定Topic信息的Topic名称。 | topic_name |
返回参数
示例
正常返回示例
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-22 | OpenAPI 入参发生变更 | |||||
|