文档中心

云原生消息引擎

Group 管理

SearchGroups - 查询消费组列表

调用 SearchGroups 接口，查询符合条件的 Consumer Group 列表。

请求说明

请求方式：GET

请求地址：https://open.volcengineapi.com?Action=SearchGroups&Version=2023-06-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

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 string[] 可选示例值：RUNNING

根据 Consumer Group 的状态进行搜索。支持配置多个状态，各状态之间使用英文逗号（,）分隔。

CreateTimeOrder string 可选示例值：DESC

按照 Consumer Group 的创建时间进行排序，取值如下：

DESC：降序排列。

ASC：升序排列。

PageNumber integer 可选示例值：1

页数。

PageSize integer 可选示例值：10

每页展示的 Consumer Group 数量。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Items object[] 示例值：\-

返回的 Consumer Group 列表详情。

Status string 示例值：RUNNING

Consumer Group 的状态。

GroupId string 示例值：25950****901433daa48208d5450cd19

Consumer Group 的 ID。

OwnerId string 示例值：36****65

Consumer Group 所属用户的 ID。

GroupName string 示例值：bmq-cg-1

Consumer Group 的名称。

OwnerName string 示例值：wu****an@bytedance.com

Consumer Group 所属用户。

CreateTime string 示例值：2024-12-06T10:20:00

Consumer Group 的创建时间。

InstanceId string 示例值：o-00c0****m46c

Consumer Group 所属实例的 ID。

Description string 示例值：测试使用

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​
    }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	InvalidParameter	parameter is invalid, pls check parameters	参数值无效。
200	Unauthorized	authorized error	授权错误，请授权或切换账号后重试。
200	InternalServiceError	internal service error, please contact with admin	内部服务错误，请联系技术支持或提交工单。
200	DatabaseError	database error	数据库错误。
200	ParameterEncodingError	Failure encoding object into query map	参数编码异常，请联系技术支持或提交工单。

最近更新时间：2025.08.05 18:34:37

这个页面对您有帮助吗？

有用

无用