调用 SearchTopics 接口，查询符合条件的 Topic 列表。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | SearchTopics | 要执行的操作，取值：SearchTopics。 |
Version | String | 是 | 2023-06-01 | API的版本，取值：2023-06-01。 |
InstanceId | String | 否 | o-00c0****m46c | 根据实例 ID 进行查询。 |
SearchKey | String | 否 | topic-test | 根据 Topic 名称关键词进行模糊查询。 |
Status | Array of String | 否 | RUNNING | 根据 Topic 状态进行查询。 |
CreateTimeOrder | String | 否 | DESC | 按照 Topic 的创建时间进行排序，支持以下排序方式：
|
PageNumber | Integer | 否 | 1 | 页数。 |
PageSize | Integer | 否 | 10 | 每页展示的 Topic 数量。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Items | Array of Object | - | 返回的 Topic 列表。 |
PageSize | Integer | 10 | 每页展示的 Topic 数量 |
PageCount | Integer | 1 | 总分页数。 |
PageNumber | Integer | 1 | 当前页数。 |
TotalCount | Long | 1 | 查询到的 Topic 总数。 |
POST /?Action=SearchTopics&Version=2023-06-01&InstanceId=o-00c0****m46c&SearchKey=topic-test&CreateTimeOrder=DESC&PageNumber=1&PageSize=10 HTTP/1.1 Host: bmq.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20241112T082657Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=AK********/20241112/cn-beijing/bmq/request, SignedHeaders=host;x-content-sha256;x-date, Signature=******** {}
{ "ResponseMetadata": { "RequestId": "202412061433016B8D54884B521AD5****", "Action": "SearchTopics", "Version": "2023-06-01", "Service": "bmq", "Region": "cn-beijing" }, "Result": { "Items": [ { "TopicId": "677bb****b1e406797e87e309785c4e6", "InstanceId": "o-00c0****m46c", "TopicName": "topic-test", "Status": "RUNNING", "Partitions": 12, "Retention": 72, "Description": "测试使用", "OwnerId": "36****65", "OwnerName": "wu****an@bytedance.com", "CreateTime": "2024-12-06T14:00:00" } ], "TotalCount": 1, "PageCount": 1, "PageNumber": 1, "PageSize": 10 } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。