tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeLiveTranscodeDetailInfo

Last updated: 2024-09-13 14:51:03

    1. API Description

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

    This API is used to query the transcoding details of a particular day or a specific time period. Querying may fail if the amount of data queried is too large. In such cases, try shortening the time period.

    A maximum of 200 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: DescribeLiveTranscodeDetailInfo.
    Version Yes String Common Params. The value used for this API: 2018-08-01.
    Region No String Common Params. This parameter is not required for this API.
    PushDomain No String Push domain name.
    StreamName No String Stream name.
    DayTime No String Query date (UTC+8)
    Format: yyyymmdd
    Note: you can query the statistics for a day in the past one month, with yesterday as the latest date allowed.
    PageNum No Integer Number of pages. Default value: 1.
    Up to 100 pages.
    PageSize No Integer Number of entries per page. Default value: 20,
    Value range: [10,1000].
    StartDayTime No String Start date (UTC+8)
    Format: yyyymmdd
    Note: details for the last one month can be queried.
    EndDayTime No String End date (UTC+8)
    Format: yyyymmdd
    Note: you can query the statistics for a period in the past one month, with yesterday as the latest date allowed. You must specify either DayTime, or StartDayTime and EndDayTime. If you specify all three parameters, only DayTime will be applied.

    3. Output Parameters

    Parameter Name Type Description
    DataInfoList Array of TranscodeDetailInfo Statistics list.
    PageNum Integer Page number.
    PageSize Integer Number of entries per page.
    TotalNum Integer Total number.
    TotalPage Integer Total number of pages.
    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 Sample request

    Input Example

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

{
    "PageNum": "1",
    "PageSize": "20",
    "DayTime": "20190307"
}

    Output Example

    {
    "Response": {
        "DataInfoList": [
            {
                "StreamName": "test",
                "StartTime": "2019-03-01 01:00",
                "EndTime": "2019-03-01 04:00",
                "Duration": 8,
                "ModuleCodec": "liveprocessor_H264",
                "Bitrate": 120,
                "Type": "Stream mix",
                "PushDomain": "5000.livepush.com",
                "Resolution": "480P",
                "MainlandOrOversea": "Mainland"
            }
        ],
        "PageNum": 1,
        "PageSize": 20,
        "TotalNum": 1,
        "TotalPage": 1,
        "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
    }
}

    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
    FailedOperation Operation failed.
    InvalidParameter Invalid parameter.
    InvalidParameterValue Invalid parameter value.
    ResourceNotFound.ForbidService You are blocked.
    ResourceNotFound.FreezeService Service suspended.
    ResourceNotFound.StopService The service has been suspended due to account arrears. Please top up it to a positive balance to activate the service first.
    ResourceNotFound.UserDisableService You disabled the service.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy