1. 接口描述
接口请求域名： ckafka.tencentcloudapi.com 。
获取Topic流量排行，消费者流量排行
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTopicFlowRanking。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | ckafka集群实例Id 示例值：ckafka-test |
| RankingType | 是 | String | 排行类别，PRO：Topic生产流量；CON：Topic消费流量 示例值：PRO |
| BeginDate | 否 | Timestamp ISO8601 | 排行起始日期 示例值：2019-08-19T00:00:00+08:00 |
| EndDate | 否 | Timestamp ISO8601 | 排行结束日期 示例值：2019-08-20T00:00:00+08:00 |
| BrokerIp | 否 | String | Broker IP 地址 示例值：10.0.0.14 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | TopicFlowRankingResult | 流量排行返回结果 示例值：{"BrokerIp":["10.0.0.14","10.0.0.15","10.0.0.16","10.0.0.17"],"BrokerTopicData":[],"BrokerTopicFlowData":[],"ConsumeSpeed":[{"ConsumerGroupName":"group-test","Speed":0}],"TopicFlow":[{"MessageHeap":0,"PartitionNum":3,"ReplicaNum":2,"TopicId":"topic-test","TopicName":"topic-test","TopicTraffic":"0.00"}],"TopicMessageHeap":[{"MessageHeap":0,"PartitionNum":3,"ReplicaNum":2,"TopicId":"topic-test","TopicName":"topic-test","TopicTraffic":"0.00"}]} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 Topic 流量排行
检查当前实例的主题流量top 情况
输入示例
POST / HTTP/1.1
Host: ckafka.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopicFlowRanking
<公共请求参数>
{
"InstanceId": "ckafka-vv7wpp93",
"BeginDate": "2020-09-22T00:00:00+00:00",
"EndDate": "2020-09-22T00:00:00+00:00",
"RankingType": "PRO"
}输出示例
{
"Response": {
"Result": {
"TopicFlow": [
{
"TopicName": "test-bing-v1w",
"TopicId": "topic-1jcib81g",
"PartitionNum": 10,
"ReplicaNum": 2,
"TopicTraffic": "0.00",
"MessageHeap": 3135
},
{
"TopicName": "alert-go-s1",
"TopicId": "topic-o8gy2gta",
"PartitionNum": 3,
"ReplicaNum": 2,
"TopicTraffic": "0.00",
"MessageHeap": 0
},
{
"TopicName": "alter-go-s2",
"TopicId": "topic-d6t7j7vc",
"PartitionNum": 10,
"ReplicaNum": 2,
"TopicTraffic": "0.00",
"MessageHeap": 0
}
],
"TopicMessageHeap": [
{
"TopicName": "test-bing-v1w",
"TopicId": "topic-1jcib81g",
"PartitionNum": 10,
"ReplicaNum": 2,
"TopicTraffic": "0.00",
"MessageHeap": 3135
},
{
"TopicName": "alert-go-s1",
"TopicId": "topic-o8gy2gta",
"PartitionNum": 3,
"ReplicaNum": 2,
"TopicTraffic": "0.00",
"MessageHeap": 0
},
{
"TopicName": "alter-go-s2",
"TopicId": "topic-d6t7j7vc",
"PartitionNum": 10,
"ReplicaNum": 2,
"TopicTraffic": "0.00",
"MessageHeap": 0
}
],
"ConsumeSpeed": [],
"BrokerIp": [
"10.0.156.208",
"10.0.207.248",
"10.0.207.249",
"10.0.156.205"
],
"BrokerTopicData": [],
"BrokerTopicFlowData": []
},
"RequestId": "6c6d04b5-fa2f-4b4c-913a-2bd4ee111aa4"
}
}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签名/鉴权错误。 |
| DryRunOperation | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InstanceNotExist | 实例不存在。 |
