云直播查询某段时间top n客户端ip汇总信息-API 文档-文档中心-腾讯云

1. 接口描述

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

该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。
查询某段时间top n客户端ip汇总信息（暂支持top 1000）

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTopClientIpSumInfoList。
Version	是	String	公共参数，本接口取值：2018-08-01。
Region	否	String	公共参数，本接口不需要传递此参数。
StartTime	是	String	起始时间点，使用UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。示例值：2019-03-01T00:00:00+08:00
EndTime	是	String	结束时间点，使用UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。时间跨度在[0,4小时]，支持最近1天数据查询。示例值：2019-03-01T04:00:00+08:00
PlayDomains.N	否	Array of String	播放域名，默认为不填，表示求总体数据。示例值：["live.com"]
PageNum	否	Integer	页号，范围是[1,1000]，默认值是1。示例值：2
PageSize	否	Integer	每页个数，范围是[1,1000]，默认值是20。示例值：2
OrderParam	否	String	排序指标，可选值包括TotalRequest（默认值），FailedRequest,TotalFlux。示例值：TotalFlux
MainlandOrOversea	否	String	地域，可选值：Mainland，Oversea，China，Foreign，Global（默认值）；如果为空，查询总的数据；如果为“Mainland”，查询中国大陆的数据；如果为“Oversea”，则查询中国大陆以外的数据；如果为China，查询中国的数据（包括港澳台）；如果为Foreign，查询国外的数据（不包括港澳台）。示例值：Mainland
OutLanguage	否	String	输出字段使用的语言，可选值：Chinese（默认值），English；目前国家，省份和运营商支持多语言。示例值：Chinese

3. 输出参数

参数名称	类型	描述
PageNum	Integer	页号，范围是[1,1000]，默认值是1。示例值：2
PageSize	Integer	每页个数，范围是[1,1000]，默认值是20。示例值：2
OrderParam	String	排序指标，可选值包括”TotalRequest”，”FailedRequest”,“TotalFlux”。示例值：TotalFlux
TotalNum	Integer	记录总数。示例值：1000
TotalPage	Integer	记录总页数。示例值：500
DataInfoList	Array of ClientIpPlaySumInfo	数据内容。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopClientIpSumInfoList
<公共请求参数>

{
    "OrderParam": "TotalFlux",
    "EndTime": "2019-03-01T04:00:00+08:00",
    "PageNum": "2",
    "PageSize": "2",
    "StartTime": "2019-03-01T00:00:00+08:00"
}

输出示例

{
    "Response": {
        "DataInfoList": [
            {
                "ClientIp": "119.44.7.168",
                "CountryArea": "中国",
                "Province": "湖南省",
                "TotalFailedRequest": 4,
                "TotalFlux": 13321.099,
                "TotalRequest": 740
            },
            {
                "ClientIp": "119.44.7.175",
                "CountryArea": "中国",
                "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 平台

腾讯云 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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。
ResourceNotFound.ForbidService	用户被禁用。
ResourceNotFound.FreezeService	用户服务被冻结。
ResourceNotFound.StopService	账号停服，请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService	用户主动停服。

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

本页目录：