1. 接口描述
接口请求域名: trro.tencentcloudapi.com 。
获取各时间段的会话统计值
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeSessionStatisticsByInterval。 | 
| Version | 是 | String | 公共参数,本接口取值:2022-03-25。 | 
| Region | 否 | String | 公共参数,此参数为可选参数。 | 
| ProjectId | 是 | String | 项目ID 示例值:f3glr49ry0i0xlm7 | 
| StatisticInterval | 是 | String | 统计时间间隔:hour|day|month 示例值:hour | 
| DeviceId | 否 | String | 设备ID 示例值:dev1 | 
| StartTime | 否 | Integer | 起始时间,单位:秒 示例值:1600000000 | 
| EndTime | 否 | Integer | 结束时间,单位:秒 示例值:1610000000 | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| SessionStatistics | Array of SessionIntervalStatistic | 各时间段的会话统计数据 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: trro.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSessionStatisticsByInterval
<公共请求参数>
{
    "ProjectId": "abcdefg",
    "EndTime": "1670000000",
    "StatisticInterval": "hour",
    "DeviceId": "dev2",
    "StartTime": "0"
}输出示例
{
    "Response": {
        "RequestId": "abcdefg-774e-4756-9f5b-8faa55ae1e5b",
        "SessionStatistics": [
            {
                "ActiveFieldDeviceNum": 1,
                "ActiveRemoteDeviceNum": 0,
                "SessionNum": 1,
                "StartTime": 1661151600,
                "EndTime": 1661152600,
                "TotalDuration": 20,
                "NotBadSessionRatio": 50
            },
            {
                "ActiveFieldDeviceNum": 1,
                "ActiveRemoteDeviceNum": 0,
                "SessionNum": 2,
                "StartTime": 1661162400,
                "EndTime": 1661152600,
                "TotalDuration": 20,
                "NotBadSessionRatio": 10
            },
            {
                "ActiveFieldDeviceNum": 1,
                "ActiveRemoteDeviceNum": 1,
                "SessionNum": 4,
                "StartTime": 1661166000,
                "EndTime": 1661176000,
                "TotalDuration": 604,
                "NotBadSessionRatio": 20
            },
            {
                "ActiveFieldDeviceNum": 1,
                "ActiveRemoteDeviceNum": 0,
                "SessionNum": 1,
                "StartTime": 1661166000,
                "EndTime": 1661176000,
                "TotalDuration": 10,
                "NotBadSessionRatio": 30
            }
        ]
    }
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| FailedOperation | 操作失败。 | 
| InternalError | 内部错误。 | 
| InvalidParameter | 参数错误。 | 
| InvalidParameterValue | 参数取值错误。 | 
| MissingParameter | 缺少参数错误。 | 
| OperationDenied | 操作被拒绝。 | 
| ResourceNotFound | 资源不存在。 |