이 페이지는 현재 영어로만 제공되며 한국어 버전은 곧 제공될 예정입니다. 기다려 주셔서 감사드립니다.

DescribeScaleInfo

1. API Description

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

This API (the old DescribeHistoryScale) is used to query the daily number of rooms and users of an application (SDKAppID) in the last 14 days. Data for the current day cannot be queried.

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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DescribeScaleInfo.
VersionYesStringCommon Params. The value used for this API: 2019-07-22.
RegionYesStringCommon Params. For more information, please see the list of regions supported by the product. This API only supports: ap-beijing, ap-guangzhou, ap-mumbai, ap-singapore, na-toronto.
SdkAppIdYesIntegerThe application ID, such as 1400xxxxxx.
StartTimeYesIntegerThe start time, which is a Unix timestamp (seconds) in local time, such as 1590065777.
Note: Only data in the last 14 days can be queried.
EndTimeYesIntegerThe end time, which is a Unix timestamp (seconds) in local time, such as 1590065877. The end time and start time should preferably be more than 24 hours apart.
Note: Data is collected on a daily basis. To query the data of a day, make sure the end time is later than 00:00 on that day. Otherwise, no data will be returned. For example, to query the data on the 20th, the end time must be later than 00:00 on the 20th.

3. Output Parameters

Parameter NameTypeDescription
TotalIntegerThe number of records returned.
ScaleListArray of ScaleInfomationThe returned data.
Note: This field may return null, indicating that no valid values can be obtained.
RequestIdStringThe 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 number of rooms and users

This example shows you how to query the number of rooms and users.

Input Example

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeScaleInfo
<Common request parameters>

{
    "StartTime": 1590065777,
    "SdkAppId": 1400353843,
    "EndTime": 1590065877
}

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

SDK

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

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 CodeDescription
InternalErrorInternal error.
InternalError.DBErrorAn error occurred while querying the database.
InternalError.HttpParaseFaliedFailed to parse the HTTP request.
InternalError.InterfaceErrAPI error.
InternalError.MethodErrUnsupported method.
InvalidParameter.BodyParamsErrorFailed to parse body parameters.
InvalidParameter.EndTsInvalid EndTs.
InvalidParameter.SdkAppIdSdkAppId is incorrect.
InvalidParameter.SdkAppidInoperable SdkAppid.
InvalidParameter.StartTsInvalid StartTs.
InvalidParameter.StartTsOversizeThe start time for query exceeded the limit.
InvalidParameter.UserIdsMorethanSixThe number of users exceeds 6.
MissingParameter.EndTsendTS_s is missing.
MissingParameter.SdkAppIdSdkAppId is missing.
MissingParameter.StartTsstartTS_s is missing.