tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeStreamLiveTranscodeDetail

Last updated: 2024-10-17 10:19:31

    1. API Description

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

    This API is used to query the transcoding information of StreamLive streams.

    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: DescribeStreamLiveTranscodeDetail.
    Version Yes String Common Params. The value used for this API: 2020-03-26.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    StartDayTime Yes String The query start time (UTC+8) in the format of yyyy-MM-dd.
    You can only query data in the last month (not including the current day).
    EndDayTime Yes String The query end time (UTC+8) in the format of yyyy-MM-dd.
    You can only query data in the last month (not including the current day).
    ChannelId No String The channel ID (optional).
    PageNum No Integer The number of pages. Default value: 1.
    The value cannot exceed 100.
    PageSize No Integer The number of records per page. Default value: 10.
    Value range: 1-1000.

    3. Output Parameters

    Parameter Name Type Description
    Infos Array of DescribeTranscodeDetailInfo A list of the transcoding information.
    PageNum Integer The number of the current page.
    PageSize Integer The number of records per page.
    TotalNum Integer The total number of records.
    TotalPage Integer The 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: mdl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStreamLiveTranscodeDetail
<Common request parameters>

{
    "EndDayTime": "2022-01-01",
    "ChannelId": "",
    "PageNum": 1,
    "PageSize": 100,
    "StartDayTime": "2022-01-01"
}

    Output Example

    {
    "Response": {
        "TotalPage": 10,
        "PageNum": 1,
        "PageSize": 10,
        "RequestId": "xx",
        "Infos": [
            {
                "Type": "merge_stream",
                "Bitrate": 1000,
                "PushDomain": "",
                "ChannelId": "12AB3E5F",
                "ModuleCodec": "liveprocessor_H264",
                "StartTime": "2022-01-01 01:00:00",
                "Duration": 10,
                "EndTime": "2022-01-01 01:00:10",
                "Resolution": "480P"
            }
        ],
        "TotalNum": 100
    }
}

    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
    InternalError Internal error.
    InvalidParameter.ChannelId Channel ID error.
    InvalidParameter.EndTime Invalid EndTime.
    InvalidParameter.Id Invalid Id.
    InvalidParameter.PageNum Page number error.
    InvalidParameter.StartTime Invalid StartTime.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy