Help & DocumentationLive Video BroadcastingCloud APILive Stream Management APIsDescribeLiveStreamOnlineList

DescribeLiveStreamOnlineList

Last updated: 2020-03-20 17:18:53

PDF

Contents：

1. API Description

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

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

A maximum of 500 requests can be initiated per second for this API.

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 parameter. The value used for this API: DescribeLiveStreamOnlineList.
Version Yes String Common parameter. The value used for this API: 2018-08-01.
Region No String Common parameter. This parameter is not required for this API.
DomainName No String Push domain name. If you use multiple paths, enter the DomainName.
AppName No String Push path, which is the same as the AppName in push and playback addresses and is live by default. If you use multiple paths, enter the AppName.
PageNum No Integer Page number to get. Default value: 1.
PageSize No Integer Number of entries per page. Maximum value: 100.
Value: any integer between 10 and 100.
Default value: 10.
StreamName No String Stream name, which is used for exact query.

3. Output Parameters

Parameter Name Type Description
TotalNum Integer Total number of eligible ones.
TotalPage Integer Total number of pages.
PageNum Integer Page number.
PageSize Integer Number of entries displayed per page.
OnlineInfo Array of StreamOnlineInfo Active push information list.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Request Example

Input Example

https://live.tencentcloudapi.com/?Action=DescribeLiveStreamOnlineList
&DomainName=5000.livepush.myqcloud.com
&AppName=live
&PageNum=1
&PageSize=10
&<common request parameters>

Output Example

{
  "Response": {
    "OnlineInfo": [
      {
        "StreamName": "5000_abcdefg",
        "AppName": "live",
        "DomainName": "5000.livepush.myqcloud.com",
        "PublishTimeList": [
          {
            "PublishTime": "2017-10-24T12:00:00Z"
          }
        ]
      }
    ],
    "TotalNum": 100,
    "TotalPage": 10,
    "PageNum": 1,
    "PageSize": 10,
    "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.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 Wrong parameter value.
MissingParameter Missing parameter.
ResourceNotFound.UserNotExist The LVB service has not been activated.