1. 接口描述
接口请求域名： tiw.tencentcloudapi.com 。
查询互动白板各个子产品用量
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeApplicationUsage。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| BeginTime | 是 | Timestamp | 用量开始时间（包括该时间点） 示例值：2019-10-01 00:00:00 |
| EndTime | 是 | Timestamp | 用量结束时间（不包括该时间点） 示例值：2019-12-31 00:00:00 |
| SubProduct | 是 | String | 白板子产品名 示例值：sp_tiw_ric |
| TimeLevel | 是 | String | 时间跨度单位 - MONTHLY：月 - DAILY：天 - MINUTELY：分钟 示例值：DAILY |
| SdkAppId | 否 | Integer | 白板应用的SdkAppId 示例值：1400000001 |
| IsWeighted | 否 | Boolean | true: 返回加权求和后的用量数据 false: 返回原始用量数据 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of DataItem | 画图所需的用量数据 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询白板用量
按天查询白板用量
输入示例
POST / HTTP/1.1
Host: tiw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplicationUsage
<公共请求参数>
{
"TimeLevel": "DAILY",
"SubProduct": "sp_tiw_ric",
"BeginTime": "2019-10-01 00:00:00",
"SdkAppId": 1400000001,
"IsWeighted": true,
"EndTime": "2019-12-31 00:00:00"
}输出示例
{
"Response": {
"Data": [
{
"Details": [
{
"Value": 0.1,
"Weight": 0.1,
"TagName": "tag_name"
}
],
"Value": 23773611121,
"Time": "2019-11-10 00:00:00"
}
],
"RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.SdkAppIdNotFound | SdkAppId不存在或格式错误。 |
| InvalidParameter.TimeFormat | 时间格式不合法解析失败。 |
| InvalidParameter.UnmarshalJSONBodyFail | 解析JSON失败，可能参数数据类型不匹配。 |