1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
查询某时间段top n的域名或流id信息(暂支持top 1000)。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeVisitTopSumInfoList。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
StartTime | 是 | String | 起始时间点,格式为yyyy-mm-dd HH:MM:SS。 示例值:2019-03-01 00:00:00 |
EndTime | 是 | String | 结束时间点,格式为yyyy-mm-dd HH:MM:SS 时间跨度在(0,4小时],支持最近1天数据查询。 示例值:2019-03-01 04:00:00 |
TopIndex | 是 | String | 峰值指标,可选值包括”Domain”,”StreamId”。 示例值:StreamId |
PlayDomains.N | 否 | Array of String | 播放域名,默认为不填,表示求总体数据。 示例值:["live.com"] |
PageNum | 否 | Integer | 页号, 范围是[1,1000], 默认值是1。 示例值:2 |
PageSize | 否 | Integer | 每页个数,范围是[1,1000], 默认值是20。 示例值:2 |
OrderParam | 否 | String | 排序指标,可选值包括” AvgFluxPerSecond”,”TotalRequest”(默认),“TotalFlux”。 示例值:TotalFlux |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
PageNum | Integer | 页号, 范围是[1,1000], 默认值是1。 示例值:2 |
PageSize | Integer | 每页个数,范围是[1,1000], 默认值是20。 示例值:2 |
TopIndex | String | 峰值指标,可选值包括”Domain”,”StreamId”。 示例值:StreamId |
OrderParam | String | 排序指标,可选值包括” AvgFluxPerSecond”(按每秒平均流量排序),”TotalRequest”(默认,按总请求数排序),“TotalFlux”(按总流量排序)。 示例值:TotalFlux |
TotalNum | Integer | 记录总数。 示例值:1000 |
TotalPage | Integer | 记录总页数。 示例值:500 |
DataInfoList | Array of PlaySumStatInfo | 数据内容。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
https://live.tencentcloudapi.com/?Action=DescribeVisitTopSumInfoList
&StartTime=2019-03-01 00:00:00
&EndTime=2019-03-01 04:00:00
&PageSize=2
&PageNum=2
&TopIndex=StreamId
&OrderParam=TotalFlux
&<公共请求参数>
输出示例
{
"Response": {
"DataInfoList": [
{
"AvgFluxPerSecond": 4.773,
"Name": "CSZFMPP360",
"TotalRequest": 36590,
"TotalFlux": 69023.772
},
{
"AvgFluxPerSecond": 4.634,
"Name": "CSNXMPP360",
"TotalRequest": 88629,
"TotalFlux": 67009.417
}
],
"OrderParam": "TotalFlux",
"PageNum": 2,
"PageSize": 2,
"RequestId": "k54e3deb-f318-4147-8a68-3c959642f9ec",
"TopIndex": "StreamId",
"TotalNum": 1000,
"TotalPage": 500
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound.ForbidService | 用户被禁用。 |
ResourceNotFound.FreezeService | 用户服务被冻结。 |
ResourceNotFound.StopService | 账号停服,请先冲正开通服务后再操作。 |
ResourceNotFound.UserDisableService | 用户主动停服。 |