查询消费分组信息
最近更新时间: 2022-05-10 11:14:35
1. 接口描述
接口请求域名： ckafka.api3.fincloud.tencent.cn。
查询消费分组信息
默认接口请求频率限制：100次/秒。
接口更新时间：2020-03-02 18:46:04。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeConsumerGroup |
| Version | 是 | String | 公共参数，本接口取值：2019-08-19 |
| Region | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceId | 是 | String | ckafka实例id。 |
| GroupName | 否 | String | 可选，用户需要查询的group名称。 |
| TopicName | 否 | String | 可选，用户需要查询的group中的对应的topic名称，如果指定了该参数，而group又未指定则忽略该参数。 |
| Limit | 否 | Int64 | 本次返回个数限制 |
| Offset | 否 | Int64 | 偏移位置 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | ConsumerGroupResponse | 返回的消费分组信息 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.RepetitionValue | 已存在相同参数。 |
| InvalidParameterValue.WrongAction | Action参数取值错误。 |
| InvalidParameterValue.InstanceNotExist | 实例不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation.OssReject | Oss拒绝该操作 |
| InvalidParameterValue.SubnetNotBelongToZone | 子网不属于zone |
| InvalidParameterValue.VpcIdInvalid | 无效的 Vpc Id |
| InvalidParameterValue.SubnetIdInvalid | 无效的子网id |
| InvalidParameterValue.ZoneNotSupport | zone不支持 |
| UnsupportedOperation.BatchDelInstanceLimit | 批量删除实例限制 |
| InternalError | 内部错误。 |
| ResourceUnavailable | 资源不可用。 |