tencent cloud



Last updated: 2023-09-06 15:06:17

1. API Description

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

This API is used to query the time shifted streams in a specific time period (up to 24 hours).

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: DescribeTimeShiftStreamList.
Version Yes String Common Params. The value used for this API: 2018-08-01.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore, eu-frankfurt.
StartTime Yes Integer The start time, which must be a Unix timestamp.
EndTime Yes Integer The end time, which must be a Unix timestamp.
StreamName No String The stream name.
Domain No String The push domain.
DomainGroup No String The group the push domain belongs to.
PageSize No Integer The maximum number of records to return. Value range: 0-100. If you do not specify this parameter or pass in 0,
the default value 100 will be used. If you pass in a negative number or a value greater than 100, an error will be returned.
PageNum No Integer The number of page to pull records from. If you do not specify this parameter, the default value 1 will be used.

3. Output Parameters

Parameter Name Type Description
TotalSize Integer The total number of records in the specified time period.
StreamList Array of TimeShiftStreamInfo The information of the streams.
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 DescribeTimeShiftStreamList

Queries time shifted streams

Input Example

Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimeShiftStreamList
<Common Request Parameters>

    "StartTime": 1668064484,
    "EndTime": 1668074484

Output Example

    "Response": {
        "RequestId": "xxx",
        "TotalSize": 100,
        "StreamList": [
                "DomainGroup": "",
                "Domain": "5000.live.push.com",
                "AppName": "live",
                "StreamName": "livetest",
                "StartTime": 1668064484,
                "EndTime": 1668064584,
                "Duration": 604800,
                "TransCodeId": 330587
                "StreamType": 2

5. Developer Resources


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.
InternalError.GetConfigError Error getting the configuration.
InternalError.NetworkError Internal network error.
InvalidParameter Invalid parameter.
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.
UnsupportedOperation Unsupported operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support