活跃用户查询

最近更新时间:2024-03-12 01:14:33

我的收藏

1. 接口描述

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

DescribeIpVisit 用于查询 5 分钟活跃用户数,及日活跃用户数明细

  • 5 分钟活跃用户数:根据日志中客户端 IP,5 分钟粒度去重统计
  • 日活跃用户数:根据日志中客户端 IP,按天粒度去重统计

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeIpVisit。
Version String 公共参数,本接口取值:2018-06-06。
Region String 公共参数,本接口不需要传递此参数。
StartTime Timestamp 查询起始时间,如:2018-09-04 10:40:10,返回结果大于等于指定时间
根据指定时间粒度不同,会进行向前归整,如 2018-09-04 10:40:10 在按 5 分钟的时间粒度查询时,返回的第一个数据对应时间点为 2018-09-04 10:40:00
示例值:2018-09-04 10:40:10
EndTime Timestamp 查询结束时间,如:2018-09-04 10:40:10,返回结果小于等于指定时间
根据指定时间粒度不同,会进行向前归整,如 2018-09-04 10:40:10 在按 5 分钟的时间粒度查询时,返回的最后一个数据对应时间点为 2018-09-04 10:40:00
示例值:2018-09-04 10:40:10
Domains.N Array of String 指定查询域名列表,最多可一次性查询 30 个加速域名明细
Project Integer 指定要查询的项目 ID,前往查看项目 ID
未填充域名情况下,指定项目查询,若填充了具体域名信息,以域名为主
示例值:0
Interval String 时间粒度,支持以下几种模式:
5min:5 分钟粒度,查询时间区间 24 小时内,默认返回 5 分钟粒度活跃用户数
day:天粒度,查询时间区间大于 1 天时,默认返回天粒度活跃用户数
示例值:5min

3. 输出参数

参数名称 类型 描述
Interval String 数据统计的时间粒度,支持5min, day,分别表示5分钟,1天的时间粒度。
示例值:5min
Data Array of ResourceData 各个资源的回源数据详情。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询活跃IP详情

输入示例

https://cdn.tencentcloudapi.com/?Action=DescribeIpVisit
&StartTime=2018-09-04 00:00:00
&EndTime=2018-09-04 12:00:00
&Domains.0=www.test.com
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "123",
        "Data": [
            {
                "Resource": "multiDomains",
                "CdnData": [
                    {
                        "Metric": "ipVisit",
                        "DetailData": [
                            {
                                "Time": "2018-09-03 00:00:00",
                                "Value": 10
                            },
                            {
                                "Time": "2018-09-03 00:05:00",
                                "Value": 20
                            }
                        ],
                        "SummarizedData": {
                            "Name": "sum",
                            "Value": 30
                        }
                    }
                ]
            }
        ],
        "Interval": 5
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.CamSystemError 内部鉴权系统错误。
InternalError.CdnConfigError 域名配置更新失败。
InternalError.CdnDbError 内部数据错误,请联系腾讯云工程师进一步排查。
InternalError.CdnQuerySystemError 内部查询错误,请重试或联系客服人员解决。
InternalError.CdnSystemError 系统错误,请联系腾讯云工程师进一步排查。
InternalError.DataSystemError 数据查询错误,请联系腾讯云工程师进一步排查。
InternalError.Error 内部服务错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnHostInvalidParam 域名格式不合法,请确认后重试。
InvalidParameter.CdnInterfaceError 内部接口错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnInvalidParamInterval 参数Interval错误,请确认后重试。
InvalidParameter.CdnParamError 参数错误,请参考文档中示例参数填充。
InvalidParameter.CdnStatInvalidDate 日期不合法,请参考文档中日期示例。
InvalidParameter.CdnStatInvalidMetric 统计类型不合法,请参考文档中统计分析示例。
InvalidParameter.CdnStatInvalidProjectId 项目ID错误,请确认后重试。
ResourceNotFound.CdnHostNotExists 未查询到该域名,请确认域名是否正确。
ResourceNotFound.CdnProjectNotExists 项目不存在,请确认后重试。
ResourceNotFound.CdnUserNotExists 未开通CDN服务,请开通后使用此接口。
UnauthorizedOperation.CdnAccountUnauthorized 子账号禁止查询整体数据。
UnauthorizedOperation.CdnCamUnauthorized 子账号未配置cam策略。
UnauthorizedOperation.CdnHostUnauthorized CDN子账号加速域名未授权。
UnauthorizedOperation.CdnProjectUnauthorized 子账号项目未授权。
UnauthorizedOperation.CdnUserIsSuspended 加速服务已停服,请重启加速服务后重试。
UnauthorizedOperation.CdnUserNoWhitelist 非内测白名单用户,无该功能使用权限。
UnauthorizedOperation.OperationTooOften 操作超出调用频次限制。