文档中心 云直播 API 文档 统计查询相关接口 查询某段时间top n客户端ip汇总信息

查询某段时间top n客户端ip汇总信息

最近更新时间:2019-07-24 15:24:58

1. 接口描述

接口请求域名: live.tencentcloudapi.com 。

查询某段时间top n客户端ip汇总信息(暂支持top 1000)

默认接口请求频率限制:100次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTopClientIpSumInfoList
Version String 公共参数,本接口取值:2018-08-01
Region String 公共参数,本接口不需要传递此参数。
StartTime String 起始时间点,格式为yyyy-mm-dd HH:MM:SS。
EndTime String 结束时间点,格式为yyyy-mm-dd HH:MM:SS
时间跨度在(0,4小时],支持最近1天数据查询。
PlayDomains.N Array of String 播放域名,默认为不填,表示求总体数据。
PageNum Integer 页号,
范围是[1,1000],
默认值是1。
PageSize Integer 每页个数,范围是[1,1000],
默认值是20。
OrderParam String 排序指标,可选值包括”TotalRequest”,”FailedRequest”,“TotalFlux”。

3. 输出参数

参数名称 类型 描述
PageNum Integer 页号,
范围是[1,1000],
默认值是1。
PageSize Integer 每页个数,范围是[1,1000],
默认值是20。
OrderParam String 排序指标,可选值包括”TotalRequest”,”FailedRequest”,“TotalFlux”。
TotalNum Integer 记录总数。
TotalPage Integer 记录总页数。
DataInfoList Array of ClientIpPlaySumInfo 数据内容。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

https://live.tencentcloudapi.com/?Action=DescribeTopClientIpSumInfoList
&StartTime=2019-03-01 00:00:00
&EndTime=2019-03-01 12:00:00
&PageSize=2
&PageNum=2
&OrderParam=TotalFlux
&<公共请求参数>

输出示例

{
  "Response": {
    "DataInfoList": [
      {
        "ClientIp": "119.44.7.168",
        "Province": "湖南省",
        "TotalFailedRequest": 4,
        "TotalFlux": 13321.099,
        "TotalRequest": 740
      },
      {
        "ClientIp": "119.44.7.175",
        "Province": "湖省",
        "TotalFailedRequest": 3,
        "TotalFlux": 12566.334,
        "TotalRequest": 2318
      }
    ],
    "OrderParam": "TotalFlux",
    "PageNum": 2,
    "PageSize": 2,
    "RequestId": "k54e3deb-f318-4147-8a68-3c959642f9ec",
    "TotalNum": 1000,
    "TotalPage": 500
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败
InvalidParameter 参数错误
MissingParameter 缺少参数错误