调用 DescribeGroup 接口，查询目标 Consumer Group 的详情。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | DescribeGroup | 要执行的操作，取值：DescribeGroup。 |
Version | String | 是 | 2023-06-01 | API的版本，取值：2023-06-01。 |
GroupId | String | 否 | b3f31****1f346a582e976cb8afdd06f | 需要查询的 Consumer Group 的 ID。 说明 若不使用 GroupId 查询 Consumer Group，需要同时配置 InstanceId 和 GroupName。 |
InstanceId | String | 否 | o-00c0****m46c | 需要查询的 Consumer Group 所属 BMQ 实例的 ID。 |
GroupName | String | 否 | bmq-cg-1 | 需要查询的 Consumer Group 的名称。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Status | String | RUNNING | Consumer Group 的状态。 |
GroupId | String | b3f31****1f346a582e976cb8afdd06f | 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 | 所属 BMQ 实例 ID。 |
Description | String | 测试使用 | Consumer Group 的描述语句。 |
POST /?Action=DescribeGroup&Version=2023-06-01&GroupId=b3f31****1f346a582e976cb8afdd06f HTTP/1.1 Host: bmq.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20241112T073423Z 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": "202411042129021851871481963F****", "Action": "DescribeGroup", "Version": "2023-06-01", "Service": "bmq", "Region": "cn-beijing" }, "Result": { "Status": "RUNNING", "GroupId": "b3f3**e976cb8afdd06f", "OwnerId": "36****65", "GroupName": "bmq-cg-1", "OwnerName": "wu****an@bytedance.com", "CreateTime": "2024-12-06T10:20:00", "InstanceId": "o-00c0****m46c", "Description": "测试使用" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。