edit-icon download-icon

DescribeLiveStreamHistoryUserNum

Last Updated: Jun 28, 2018

Description

Query history user number of live streams.

Request parameters

Parameters Type Required Example values Description
Action String Yes DescribeLiveStreamHistoryUserNum

The name of this interface. Value: DescribeLiveStreamHistoryUserNum

AppName String Yes testApp

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

DomainName String Yes www.yourdomain.com

Your domain name.

EndTime String Yes 2017-12-22T08:00:00Z

End time.

  • UTC format.
  • The time interval between StartTime and EndTime is within 1 day, and EndTime does not exceed the current time.

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

Start time.

  • UTC format.
  • The time interval between StartTime and EndTime is within 1 day.

StreamName String Yes testStream

Name of the live stream.

Return parameters

Parameters Type Example values Description
RequestId String 40A4F36D-A7CC-473A-88E7-154F92242566

The ID of the job request.

LiveStreamUserNumInfos

History online user number information of live stream.

  └UserNum String 1

User number.

  └StreamTime String 2017-10-20T06:20:00Z

Stream time.

  • UTC format.

Example

Request example

  1. https://live.aliyuncs.com?Action= DescribeLiveStreamHistoryUserNum&DomainName=live.aliyunlive.com&AppName=xxx&StartTime=2017-08-30T07:30:30Z&EndTime=2017-08-30T07:45:00Z&<Public Request Parameter>

Normal return example

JSON format

  1. {
  2. "LiveStreamUserNumInfos":{
  3. "LiveStreamUserNumInfo":[
  4. {
  5. "StreamTime":"2017-10-20T06:20:00Z",
  6. "UserNum":0
  7. },
  8. {
  9. "StreamTime":"2017-10-20T06:19:00Z",
  10. "UserNum":0
  11. },
  12. {
  13. "StreamTime":"2017-10-20T06:18:00Z",
  14. "UserNum":15
  15. },
  16. {
  17. "StreamTime":"2017-10-20T06:17:00Z",
  18. "UserNum":0
  19. },
  20. {
  21. "StreamTime":"2017-10-20T06:16:00Z",
  22. "UserNum":0
  23. },
  24. {
  25. "StreamTime":"2017-10-20T06:15:00Z",
  26. "UserNum":6
  27. },
  28. {
  29. "StreamTime":"2017-10-20T06:14:00Z",
  30. "UserNum":0
  31. }
  32. ]
  33. },
  34. "RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F5FF8"
  35. }

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.