edit-icon download-icon

DescribeLiveStreamsOnlineList

Last Updated: Mar 19, 2018

Description

View the information of all the streams being pushed under a specific domain name (or an app under a specified domain name).

Request parameters

Parameters Type Required Example values Description
Action String Yes DescribeLiveStreamsOnlineList

The name of this interface. Value: DescribeLiveStreamsOnlineList

DomainName String Yes play.yourdomain.com

Your Live domain name.

AppName String No testApp

Name of the app.

PageNum Integer No 1

The page number.
Default value: 1

PageSize Integer No 1500

The page size, maximum: 3000.
Range: random integer between 1 to 3000
Default value: 2000

StreamType String No all

Stream type. Range:

  • all
  • raw
  • trans
Correspondingly check all the streams, raw streams and transcoding streams. Default: all means returing all ll the stream information.

Return parameters

Parameters Type Example values Description
OnlineInfo

Information of the stream being pushed.

  └DomainName String play.yourdomain.com

The Live domain name, which the stream belongs to.

  └AppName String AppName

Name of the app, which the stream belongs to.

  └StreamName String StreamName

Name of the stream.

  └PublishTime String 2015-12-02T06:58:04Z

The time when streaming starts in UTC.

  └PublishUrl String rtmp://play.aliyunlive.com/AppName/StreamName

The full streaming URL.

  └PublishDomain String push.aliyunlive.com

The live streaming domain name. If using the center streaming, you can enter the playback domain name directly.

RequestId String 40A4F36D-A7CC-473A-88E7-154F92242566

The ID of the job request.

PageNum Integer 1

The page number.

PageSize Integer 10

The page size.

TotalNum Integer 10

The total number that comforms with the conditions.

TotalPage Integer 100

The total number of pages.

Example

Request example

  1. https://live.aliyuncs.com/?Action=DescribeLiveStreamsOnlineList&DomainName=test101.aliyunlive.com&PageSize=10&PageNum=2&<Public Request Parameter>

For more information, see Public Request Parameter.

Normal return example

JSON format

  1. {
  2. "OnlineInfo":{
  3. "LiveStreamOnlineInfo":[{
  4. "AppName":"xchen",
  5. "DomainName":"test101.cdnpe.com",
  6. "PublishTime":"2015-12-02T06:58:04Z",
  7. "PublishUrl":"rtmp://test101.cdnpe.com/xchen",
  8. "StreamName":"testxchen"
  9. }]
  10. },
  11. "PageNum":2,
  12. "PageSize":10,
  13. "RequestId":"0D70427D-91E4-4349-AAD3-5511A5BB823B",
  14. "TotalNum":11,
  15. "TotalPage":2
  16. }

Exception return example

JSON format

  1. {
  2. "Code":"InternalError",
  3. "HostId":"live.aliyuncs.com",
  4. "Message":"The request processing has failed due to some unknown error.",
  5. "RequestId":"6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
  6. }

Error code

For more information about error code of this product, see Error code.

Thank you! We've received your feedback.