Domain name for API request: trtc.tencentcloudapi.com.
This API is used to query your usage of TRTC’s relay to CDN service.
A maximum of 5 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: 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. |
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. |
SDKAppID
is 1400123456
from January 1, 2022 to January 2, 2022POST / 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
}
{
"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"
}
}
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 |
---|---|
InvalidParameter.QueryScaleOversize | The query period exceeds the limit. |
InvalidParameter.SdkAppId | SdkAppId is incorrect. |
Was this page helpful?