tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBoardSDKLog

Last updated: 2024-11-26 18:56:59

    1. API Description

    Domain name for API request: tiw.intl.tencentcloudapi.com.

    This API is used to query the logs of a whiteboard application on a client.

    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 Name Required Type Description
    Action Yes String Common Params. The value used for this API: DescribeBoardSDKLog.
    Version Yes String Common Params. The value used for this API: 2019-09-19.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou.
    SdkAppId Yes Integer SdkAppId of the whiteboard application.
    RoomId Yes String Room ID to be used to query logs.
    UserId Yes String User ID to be used to query logs.
    TimeRange.N Yes Array of Integer Query period, which consists of two Unix timestamps in milliseconds. The first indicates the start time and the second the end time.
    AggregationInterval Yes String Interval for aggregating log number queries. Example values: 5m, 1h, 4h
    Query No String Extra query conditions.
    Ascending No Boolean Specifies whether to sort results in ascending order of time.
    Context No String Context key used for recursive extraction. Obtain this parameter in the response to the last request.

    3. Output Parameters

    Parameter Name Type Description
    Total Integer Number of logs queried.
    Sources Array of String Log details.
    Buckets Array of String Number of logs queried within each time range after aggregation based on the time range.
    Context String Context key used for recursive extraction. This parameter can be used in the next request.
    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 logs of a whiteboard application

    Input Example

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

{
    "SdkAppId": 1400000001,
    "RoomId": "73394291",
    "UserId": "tic_web",
    "TimeRange": [
        1614519034000,
        1614691834999
    ],
    "Context": "",
    "AggregationInterval": "1h",
    "Query": "",
    "Ascending": true
}

    Output Example

    {
    "Response": {
        "RequestId": "52214ab1-eeaa-4c9a-aa8f-6c501f7cae18",
        "Total": 65,
        "Context": "",
        "Sources": [],
        "Buckets": []
    }
}

    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 Code Description
    AuthFailure
    FailedOperation Operation failed.
    UnauthorizedOperation Unauthorized operation.
    UnauthorizedOperation.SdkAppId The SdkAppId does not exist or does not match the current Tencent Cloud account.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy