Documentation|Tencent Cloud

Recent Pages

DescribeHistoryScale

Last updated: 2020-07-31 11:17:37

1. API Description

Domain name for API request: trtc.tencentcloudapi.com.

This API is used to query the daily numbers of rooms and users under a specified sdkqppid. It can query data once per minute for the last 5 days. If a day has not ended, the numbers of rooms and users on the day cannot be queried.

A maximum of 1 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 parameter. The value used for this API: DescribeHistoryScale.
Version	Yes	String	Common parameter. The value used for this API: 2019-07-22.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou
SdkAppId	Yes	String	User `sdkappid`
StartTime	Yes	Integer	Query start time in the format of local UNIX timestamp, such as 1588031999s, which is a point in time in the last 5 days.
EndTime	Yes	Integer	Query end time in the format of local UNIX timestamp, such as 1588031999s.

3. Output Parameters

Parameter Name	Type	Description
Total	Integer	Number of returned data entries
ScaleList	Array of ScaleInfomation	Returned data
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the number of historical rooms and users

Input Example

https://trtc.tencentcloudapi.com/?Action=DescribeHistoryScale
&SdkAppId=1400188366
&StartTime=1587571000
&EndTime=1588034999
&<common request parameters>

Output Example

{
  "Response": {
    "Total": 4,
    "ScaleList": [
      {
        "Time": 1587830400,
        "RoomNumbers": 130644,
        "UserNumber": 2111978,
        "UserCount": 7004243
      },
      {
        "Time": 1587744000,
        "RoomNumbers": 79241,
        "UserNumber": 781494,
        "UserCount": 2968232
      },
      {
        "Time": 1587657600,
        "RoomNumbers": 180341,
        "UserNumber": 3047931,
        "UserCount": 10839565
      },
      {
        "Time": 1587571200,
        "RoomNumbers": 185469,
        "UserNumber": 3267726,
        "UserCount": 11656700
      }
    ],
    "RequestId": "70259dd1-c935-4a31-8576-f4daadd942ef"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

API 3.0 Explorer

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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
InternalError	Internal error.
InternalError.DBError	An error occurred while querying the database.
InternalError.HttpParaseFalied	Failed to parse the HTTP request.
InternalError.InterfaceErr	API error.
InternalError.MethodErr	Unsupported method.
InvalidParameter.BodyParamsError	Failed to parse the body parameter.
InvalidParameter.EndTs	Invalid `EndTs`.
InvalidParameter.SdkAppId	`SdkAppId` is incorrect.
InvalidParameter.StartTs	Invalid `StartTs`.
InvalidParameter.StartTsOversize	The query start time is more than 5 days earlier than now.
InvalidParameter.UserIdsMorethanSix	The number of users exceeds 6.
MissingParameter.EndTs	`endTS_s` is missing.
MissingParameter.SdkAppId	`SdkAppId` is missing.
MissingParameter.StartTs	`startTS_s` is missing.