Tencent Interactive Whiteboard
- Product Introduction
- Purchase Guide
- Server APIs
- Making API Requests
- Whiteboard Snapshot APIs
- Whiteboard Push APIs
- Document Transcoding APIs
- Real-Time Recording APIs
- Statistics Query APIs
- Recording Video Generation APIs
- Other APIs
- Service Agreement
DescribeApplicationUsage
Last updated: 2024-11-26 18:57:01
1. API Description
Domain name for API request: tiw.intl.tencentcloudapi.com.
This API is used to query the subproduct usage of Tencent Interactive Whiteboard.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeApplicationUsage. |
| Version | Yes | String | Common Params. The value used for this API: 2019-09-19. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| BeginTime | Yes | Timestamp | Start time of the query period. The start time point is included in the query period. |
| EndTime | Yes | Timestamp | End time of the query period. The end time point is not included in the query period. |
| SubProduct | Yes | String | Subproduct name. |
| TimeLevel | Yes | String | Unit of time increment. - MONTHLY: month - DAILY: day - MINUTELY: minute |
| SdkAppId | No | Integer | SdkAppId of the whiteboard application. |
| IsWeighted | No | Boolean | true: Returns the weighted sum of raw usage data. false: Returns the raw usage data. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Data | Array of DataItem | Usage data required for drawing charts. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Querying whiteboard usage
This example shows you how to query daily whiteboard usage.
Input Example
POST / HTTP/1.1
Host: tiw.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplicationUsage
<Common request parameters>
{
"TimeLevel": "DAILY",
"SubProduct": "sp_tiw_ric",
"BeginTime": "2019-10-01 00:00:00",
"SdkAppId": 1400000001,
"IsWeighted": true,
"EndTime": "2019-12-31 00:00:00"
}
Output Example
{
"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. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | |
| InvalidParameter | A parameter error occurred. |
| InvalidParameter.SdkAppIdNotFound | The SdkAppId does not exist or is invalid. |
| InvalidParameter.TimeFormat | Parsing failed due to an invalid time format. |
| InvalidParameter.UnmarshalJSONBodyFail | JSON parsing failed, which may be due to parameter type mismatch. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No