调用 GroupExist 接口，判断目标 Consumer Group 是否存在。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | GroupExist | 要执行的操作，取值：GroupExist。 |
Version | String | 是 | 2023-06-01 | API的版本，取值：2023-06-01。 |
GroupId | String | 否 | b3f31****1f346a582e976cb8afdd06f | 需要查询的 Consumer Group 的 ID。 说明 若不使用 GroupId 查询，则需要同时填写 InstanceId 和 GroupName。 |
InstanceId | String | 否 | o-00c0****m46c | Consumer Group 所属 BMQ 实例 ID。 |
GroupName | String | 否 | bmq-cg-1 | 需要查询的 Consumer Group 的名称。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Existed | Boolean | true | Consumer Group 是否存在，取值如下：
|
POST /?Action=GroupExist&Version=2023-06-01&GroupId=b3f31****1f346a582e976cb8afdd06f HTTP/1.1 Host: bmq.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20241112T073151Z 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": "202411042122191001500722202C****", "Action": "GroupExist", "Version": "2023-06-01", "Service": "bmq", "Region": "cn-beijing" }, "Result": { "Existed": true } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。