调用 SearchGroups 接口，查询符合条件的 Consumer Group 列表。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | SearchGroups | 要执行的操作，取值：SearchGroups。 |
Version | String | 是 | 2023-06-01 | API的版本，取值：2023-06-01。 |
InstanceId | String | 否 | o-00c0****m46c | 需要查询的 Consumer Group 所属 BMQ 实例的 ID。 |
SearchKey | String | 否 | bmq-cg | 根据 Consumer Group 名称的关键词进行模糊搜索。 |
Status | Array of String | 否 | RUNNING | 根据 Consumer Group 的状态进行搜索。支持配置多个状态，各状态之间使用英文逗号（,）分隔。 |
CreateTimeOrder | String | 否 | DESC | 按照 Consumer Group 的创建时间进行排序，取值如下：
|
PageNumber | Integer | 否 | 1 | 页数。 |
PageSize | Integer | 否 | 10 | 每页展示的 Consumer Group 数量。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Items | Array of Object | - | 返回的 Consumer Group 列表详情。 |
PageSize | Integer | 10 | 每页展示的 Consumer Group 数量。 |
PageCount | Integer | 1 | 总页数。 |
PageNumber | Integer | 1 | 当前页数。 |
TotalCount | Long | 2 | 查询到的 Consumer Group 总数。 |
POST /?Action=SearchGroups&Version=2023-06-01&InstanceId=o-00c0****m46c&CreateTimeOrder=DESC&PageSize=10&SearchKey=bmq-cg HTTP/1.1 Host: bmq.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20241112T075505Z 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": "2024120611002065766989536CBF5F****", "Action": "SearchGroups", "Version": "2023-06-01", "Service": "bmq", "Region": "cn-beijing" }, "Result": { "Items": [ { "GroupId": "b3f31****1f346a582e976cb8afdd06f", "InstanceId": "o-00c0****m46c", "GroupName": "bmq-cg-2", "Status": "RUNNING", "OwnerId": "36****65", "OwnerName": "wu****an@bytedance.com", "Description": "测试使用", "CreateTime": "2024-12-06T10:20:00" }, { "GroupId": "25950****901433daa48208d5450cd19", "InstanceId": "o-00c0****m46c", "GroupName": "bmq-cg-1", "Status": "RUNNING", "OwnerId": "36****65", "OwnerName": "wu****an@bytedance.com", "Description": "测试使用", "CreateTime": "2024-12-06T10:00:00" } ], "TotalCount": 2, "PageCount": 1, "PageNumber": 1, "PageSize": 10 } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。