DescribeRelayUsage
1. API Description
Domain name for API request: trtc.tencentcloudapi.com.
This API is used to query your usage of TRTC’s relay to CDN service.
- If the period queried is one day or shorter, the statistics returned are on a five-minute basis. If the period queried is longer than one day, the statistics returned are on a daily basis.
- The period queried per request cannot be longer than 31 days.
- If you query the statistics of the current day, the statistics returned may be inaccurate due to the delay in data collection.
- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.
- The rate limit of this API is five calls per second.
A maximum of 5 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: DescribeRelayUsage. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-22. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-singapore. |
| StartTime | Yes | String | The start date in the format of YYYY-MM-DD. |
| EndTime | Yes | String | The end date in the format of YYYY-MM-DD. The period queried per request cannot be longer than 31 days. |
| SdkAppId | No | Integer | The SDKAppID of the TRTC application to which the target room belongs. If you do not specify this parameter, the usage statistics of all TRTC applications under the current account will be returned. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| UsageKey | Array of String | The usage type. Each element of this parameter corresponds to an element of UsageValue in the order they are listed. |
| UsageList | Array of TrtcUsage | The usage data in each time unit. |
| 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 the usage of the application whose SDKAppID is 1400123456 from January 1, 2022 to January 2, 2022
Input Example
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRelayUsage
<Common request parameters>
{
"EndTime": "2022-01-01",
"StartTime": "2022-01-02",
"SdkAppId": 1400123456
}
Output Example
{
"Response": {
"UsageKey": [
"Bandwidth"
],
"UsageList": [
{
"TimeKey": "2022-01-01 00:00:00",
"UsageValue": [
10.11
]
},
{
"TimeKey": "2022-01-02 00:00:00",
"UsageValue": [
10.11
]
}
],
"RequestId": "xx"
}
}
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 |
|---|---|
| InvalidParameter.QueryScaleOversize | The query period exceeds the limit. |
| InvalidParameter.SdkAppId | SdkAppId is incorrect. |