1. 接口描述
接口请求域名: dts.tencentcloudapi.com 。
本接口(DescribeConsumerGroups)用于获取订阅实例配置的消费者组详情。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeConsumerGroups。 |
Version | 是 | String | 公共参数,本接口取值:2021-12-06。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SubscribeId | 是 | String | 订阅实例id 示例值:subs-47damshnra |
Offset | 否 | Integer | 返回记录的起始偏移量。默认0 示例值:0 |
Limit | 否 | Integer | 单次返回的记录数量。默认10 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 指定实例下的消费者组总数 示例值:1 |
Items | Array of GroupInfo | 消费者组列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取数据订阅的消费组
获取数据订阅的消费组
输入示例
POST / HTTP/1.1
Host: dts.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
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
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 | 不支持的操作。 |