edit-icon download-icon

DescribeLiveStreamOnlineUserNum

Last Updated: Jun 29, 2018

Description

Get the number of real-time online users of the live stream.

Request parameters

Parameters Type Required or not Example values Description
Action String Yes DescribeLiveStreamOnlineUserNum

The name of this interface. Value: DescribeLiveStreamOnlineUserNum

DomainName String Yes www.yourdomain.com

Your CDN domain name.

AppName String No testApp

Name of the app, which the live stream belongs to.

EndTime String No 2017-12-21T08:00:00Z

End time.

  • UTC format.
  • The time interval between StartTime and EndTime is within 7 days.

HlsSwitch String No true

hls switch.

StartTime String No 2017-12-21T08:00:00Z

Start time.

  • UTC format.
  • The time interval between StartTime and EndTime is within 7 days.

StreamName String No testStream

Name of the live stream.

Return parameters

Parameters Type Example values Description
TotalUserNumber Long 2

Total number of users of all the streams.

OnlineUserInfo

Number of users of each live stream.

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

URL of the live stream.

  └UserNumber Long 2

Number of online users of the live stream.

  └Time String 2015-12-01T17:37:00Z

Statistic time.

  • UTC time, format: 2015-12-01T17:37:00Z.

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

The ID of the job request.

Example

Request example

  1. https://live.aliyuncs.com/?Action=DescribeLiveStreamOnlineUserNum&DomainName=test101.cdnpe.com&<Public Request Parameter>

For more information, see Public Request Parameter.

Normal return example

JSON format

  1. {
  2. "OnlineUserInfo":{
  3. "LiveStreamOnlineUserNumInfo":[
  4. {
  5. "StreamUrl":"rtmp://test101.cdnpe.com/live/test101",
  6. "UserNumber":2
  7. },
  8. {
  9. "StreamUrl":"rtmp://test101.cdnpe.com/live/test102",
  10. "UserNumber":5
  11. }
  12. ]
  13. },
  14. "RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  15. "TotalUserNumber":7
  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.