接口请求域名： dts.intl.tencentcloudapi.com 。
本接口(DescribeConsumerGroups)用于获取订阅实例配置的消费者组详情。
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeConsumerGroups。 |
| Version | 是 | String | 公共参数，本接口取值：2021-12-06。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SubscribeId | 是 | String | 订阅实例id，可通过DescribeSubscribeJobs接口获取。 |
| Offset | 否 | Integer | 返回记录的起始偏移量。默认0 |
| Limit | 否 | Integer | 单次返回的记录数量。默认10 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 指定实例下的消费者组总数 |
| Items | Array of GroupInfo | 消费者组列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
获取数据订阅的消费组
POST / HTTP/1.1
Host: dts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConsumerGroups
<公共请求参数>
{
"SubscribeId": "subs-9jyki7hniw"
}
{
"Response": {
"Items": [
{
"Account": "account-subs-47damshnra-3",
"ConsumerGroupLag": 464948,
"ConsumerGroupName": "consumer-grp-subs-47damshnra-3",
"ConsumerGroupOffset": -1,
"ConsumerGroupState": "Dead",
"CreatedAt": "2022-03-25 17:31:31",
"Description": "sdfjo",
"Latency": 528268,
"PartitionAssignment": [],
"StateOfPartition": [
{
"ConsumerGroupLag": 464948,
"ConsumerGroupOffset": -1,
"Latency": 528268,
"PartitionNo": 0
}
],
"UpdatedAt": "2022-03-25 17:31:31"
},
{
"Account": "account-subs-47damshnra-2",
"ConsumerGroupLag": 464948,
"ConsumerGroupName": "consumer-grp-subs-47damshnra-2",
"ConsumerGroupOffset": -1,
"ConsumerGroupState": "Dead",
"CreatedAt": "2022-03-22 17:34:31",
"Description": "sdfjo",
"Latency": 528268,
"PartitionAssignment": [],
"StateOfPartition": [
{
"ConsumerGroupLag": 464948,
"ConsumerGroupOffset": -1,
"Latency": 528268,
"PartitionNo": 0
}
],
"UpdatedAt": "2022-03-22 17:34:31"
},
{
"Account": "account-subs-47damshnra-1",
"ConsumerGroupLag": 464948,
"ConsumerGroupName": "consumer-grp-subs-47damshnra-1",
"ConsumerGroupOffset": -1,
"ConsumerGroupState": "Dead",
"CreatedAt": "2022-03-04 15:14:18",
"Description": "sdfjo",
"Latency": 528268,
"PartitionAssignment": [],
"StateOfPartition": [
{
"ConsumerGroupLag": 464948,
"ConsumerGroupOffset": -1,
"Latency": 528268,
"PartitionNo": 0
}
],
"UpdatedAt": "2022-03-04 15:14:18"
}
],
"RequestId": "68c04ba0-b0d8-11ec-98f5-11f9ac4a2e37",
"TotalCount": 3
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.AuthFailureError | 认证失败。 |
| FailedOperation | 操作失败。 |
| FailedOperation.FailedOperationError | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.InternalErrorError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidParameterError | 参数无效。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidParameterValueError | 非法参数。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.OperationDeniedError | 操作被拒绝。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.ResourceNotFoundError | 资源未找到。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.UnauthorizedOperationError | 未授权的操作。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.UnsupportedOperationError | 不支持的操作。 |
文档反馈