查询指定实例下的主题列表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rocketmq:ListTopics | list | *Topic acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/* |
| 无 |
请求语法
GET /instances/{instanceId}/topics HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
instanceId | string | 是 | 指定需要获取哪个实例下的主题列表。 | rmq-cn-7e22ody**** |
filter | string | 否 | 查询的过滤条件,若不输入则查询该实例下所有的主题。 | topic_test |
pageNumber | integer | 否 | 分页页码,查询第几页的返回结果。 | 1 |
pageSize | integer | 否 | 分页大小,每页最多显示的返回结果数量。 | 3 |
messageTypes | array | 否 | 主题的消息类型。 | |
string | 否 | 需要查询实例下哪种类型的主题。若不输入,则查询实例下的所有主题。 参数取值如下:
| NORMAL |
返回参数
示例
正常返回示例
JSON
格式
{
"requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
"success": true,
"data": {
"pageNumber": 1,
"pageSize": 3,
"totalCount": 1,
"list": [
{
"regionId": "cn-hangzhou",
"instanceId": "rmq-cn-7e22ody****",
"topicName": "topic_test",
"messageType": "NORMAL",
"status": "RUNNING",
"remark": "This is the remark for test.",
"createTime": "2022-08-01 20:05:50",
"updateTime": "2022-08-01 20:05:50",
"maxSendTps": 0
}
]
},
"code": "Topic.NotFound",
"message": "The topic cannot be found.",
"httpStatusCode": 400,
"dynamicCode": "TopicName",
"dynamicMessage": "topicName"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-03-28 | API 内部配置变更,不影响调用 | 查看变更详情 |