tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeLiveStreamPublishedList

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

1. API Description

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

This API is used to return the list of pushed streams.

Note: Up to 10,000 entries can be queried per page. More data can be obtained by adjusting the query time range.

A maximum of 300 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: DescribeLiveStreamPublishedList.
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.
DomainName Yes String Your push domain name.
EndTime Yes String End time.
In UTC format, such as 2016-06-30T19:00:00Z.
This cannot be after the current time.
Note: The difference between EndTime and StartTime cannot be greater than 30 days.
StartTime Yes String Start time.
In UTC format, such as 2016-06-29T19:00:00Z.
This supports querying data in the past 60 days.
AppName No String Push path, which is the same as the AppName in push and playback addresses and is live by default. Fuzzy match is not supported.
PageNum No Integer Page number to get.
Default value: 1.
PageSize No Integer Number of entries per page.
Maximum value: 100
Valid values: integers between 10 and 100
Default value: 10
StreamName No String Stream name, which supports fuzzy match.

3. Output Parameters

Parameter Name Type Description
PublishInfo Array of StreamName Push record information.
PageNum Integer Page number.
PageSize Integer Number of entries per page
TotalNum Integer Total number of eligible ones.
TotalPage Integer Total number of pages.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example

https://live.tencentcloudapi.com/?Action=DescribeLiveStreamPublishedList
&DomainName=5000.livepush.myqcloud.com
&AppName=live
&StreamName=test
&PageNum=1
&PageSize=10
&StartTime=2015-06-25T03:30:50Z
&EndTime=2015-12-26T03:30:50Z
&<Common request parameters>

Output Example

{
    "Response": {
        "PublishInfo": [
            {
                "AppName": "live",
                "ClientIp": "180.163.8.244",
                "DomainName": "5000.livepush.myqcloud.com",
                "Duration": 10,
                "Resolution": "640*352",
                "StopReason": "The client actively interrupts the stream",
                "StreamEndTime": "2019-01-04T11:59:58Z",
                "StreamName": "test1",
                "StreamStartTime": "2019-01-04T11:59:58Z"
            }
        ],
        "PageNum": 1,
        "PageSize": 10,
        "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.
FailedOperation.CallOtherSvrFailed Failed to call the internal service.
InternalError Internal error.
InternalError.CallOtherSvrError Error calling internal service.
InternalError.ConfigNotExist The configuration does not exist.
InternalError.GetBizidError Error getting user account.
InternalError.GetStreamInfoError Failed to get the stream information.
InternalError.GetUpstreamInfoError Error getting the live stream source information.
InternalError.NotPermmitOperat No permission to operate.
InternalError.StreamStatusError Exceptional stream status.
InternalError.UpdateDataError Failed to update data.
InvalidParameter Invalid parameter.
InvalidParameterValue Invalid parameter value.
MissingParameter Parameter missing.
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.
ResourceNotFound.UserNotExist The LVB service has not been activated.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy