Domain name for API request: tiw.tencentcloudapi.com.
This API is used to query the daily billable usage of a whiteboard application.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeTIWDailyUsage. |
Version | Yes | String | Common Params. The value used for this API: 2019-09-19. |
Region | No | String | Common Params. This parameter is not required for this API. |
SdkAppId | Yes | Integer | SdkAppId of the whiteboard application. |
SubProduct | Yes | String | Subproduct usage to be queried. The following parameters are supported: - sp_tiw_board: The duration of use of whiteboards, in minutes. - sp_tiw_dt: The number of pages dynamically transcoded. - sp_tiw_st: The number of pages statically transcoded. - sp_tiw_ric: The duration of real-time recording, in minutes. Note: Dynamic transcoding multiplies the number of pages of a document by eight times. Static transcoding does not change the number of pages of a document. |
StartTime | Yes | Date | Start date in the format of YYYY-MM-DD. The start date is included in the query period. |
EndTime | Yes | Date | End date in the format of YYYY-MM-DD. The end date is included in the query period. The period queried per request cannot be longer than 31 days. |
Parameter Name | Type | Description |
---|---|---|
Usages | Array of UsageDataItem | Usage summary of a specified product during a specified query period. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to query the whiteboard usage within the period from 2021-09-01 to 2021-09-07.
https://tiw.tencentcloudapi.com/?Action=DescribeTIWDailyUsage
&SdkAppId=1400000001
&SubProduct=sp_tiw_board
&StartTime=2021-09-01
&EndTime=2021-09-07
&<Common request parameters>
{
"Response": {
"RequestId": "cdfb2097-75d1-4159-ad37-62d9eca65d6a",
"Usages": [
{
"Time": "2021-09-01",
"SdkAppId": 1400000001,
"SubProduct": "sp_tiw_board",
"Value": 779552
},
{
"Time": "2021-09-02",
"SdkAppId": 1400000001,
"SubProduct": "sp_tiw_board",
"Value": 78118
},
{
"Time": "2021-09-03",
"SdkAppId": 1400000001,
"SubProduct": "sp_tiw_board",
"Value": 768385
},
{
"Time": "2021-09-04",
"SdkAppId": 1400000001,
"SubProduct": "sp_tiw_board",
"Value": 94257
},
{
"Time": "2021-09-05",
"SdkAppId": 1400000001,
"SubProduct": "sp_tiw_board",
"Value": 26717
},
{
"Time": "2021-09-06",
"SdkAppId": 1400000001,
"SubProduct": "sp_tiw_board",
"Value": 95296
},
{
"Time": "2021-09-07",
"SdkAppId": 1400000001,
"SubProduct": "sp_tiw_board",
"Value": 70592
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | |
InternalError | Internal error. |
InvalidParameter | A parameter error occurred. |
InvalidParameter.SdkAppIdNotFound | The SdkAppId does not exist or is invalid. |
InvalidParameter.TranscodeParameter | The document transcoding parameter format is invalid. |
ResourceUnavailable.NotRegistered | TIW is not enabled. |
ResourceUnavailable.ServiceExpired | The account is in arrears or the TIW service has expired. |
UnauthorizedOperation.SdkAppId | The SdkAppId does not exist or does not match the current Tencent Cloud account. |
Was this page helpful?