閱讀587 返回首頁    go 人物

查詢在線人數__直播流操作接口_API 手冊_CDN-阿裏雲

描述

獲取在線直播流的在線人數，支持實時查詢和基於時間範圍的查詢。

基於實時查詢在線人數的請求參數

參數 類型 必須? 描述
Action String 是 操作接口名，係統規定參數，取值：DescribeLiveStreamOnlineUserNum
DomainName String 是 您的加速域名
AppName String 否 直播流所屬應用名稱
StreamName String 否 直播流名稱

基於時間範圍的分鍾粒度的查詢在線人數的請求參數

參數 類型 必須? 描述
Action String 是 操作接口名，係統規定參數，取值：DescribeLiveStreamOnlineUserNum
DomainName String 是 您的加速域名
AppName String 是 直播流所屬應用名稱
StreamName String 是 直播流名稱
StartTime String 是 起始時間，UTC格式，例如：2016-06-29T19:00:00Z
EndTime String 是 結束時間，UTC格式，例如：2016-06-30T19:05:00Z

返回參數

名稱 類型 描述
TotalUserNumber Long 所有流的用戶數總和
OnlineUserInfo LiveStreamOnlineUserNumInfo[] 每條直播流的用戶數信息

數據類型

LiveStreamOnlineUserNumInfo

名稱 類型 描述
StreamUrl String 直播流的URL
UserNumber Long 直播流的在線人數
Time String 統計時刻 UTC時間

特殊錯誤碼

錯誤代碼 描述 Http 狀態碼 語義
InternalError The request processing has failed due to some unknown error. 500 後台發生未知錯誤
InvalidDomain.NotFound The domain provided does not exist in our records. 404 當前賬戶下未查到域名
IllegalOperation Illegal domain operate is not permitted. 403 不支持當前操作，如：非直播類域名
MissingParameter The input parameter parameter name that is mandatory for processing this request is not supplied 400 缺少參數

示例

請求示例：

  1. https://cdn.aliyuncs.com?Action=DescribeLiveStreamOnlineUserNum&DomainName=test101.cdnpe.com&<公共請求參數>

返回示例

JSON格式：

  1. {
  2.     "OnlineUserInfo": {
  3.         "LiveStreamOnlineUserNumInfo": [
  4.             {
  5.                 "StreamUrl": "rtmp://test101.cdnpe.com/live/test101", 
  6.                 "UserNumber": 2,
  7.                 "Time": 2016-06-29T19:05:00Z
  8.             }, 
  9.             {
  10.                 "StreamUrl": "rtmp://test101.cdnpe.com/live/test102", 
  11.                 "UserNumber": 5,
  12.                 "Time": 2016-06-29T19:04:00Z
  13.             }
  14.         ]
  15.     }, 
  16.     "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8", 
  17.     "TotalUserNumber": 7
  18. }

XML格式：

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2.   <DescribeLiveStreamOnlineUserNumResponse>
  3.     <OnlineUserInfo>
  4.         <LiveStreamOnlineUserNumInfo>
  5.             <StreamUrl>rtmp://test101.cdnpe.com/live/test101</StreamUrl>
  6.             <UserNumber>2</UserNumber>
  7.             <Time>2016-06-29T19:05:00Z</Time>
  8.         </LiveStreamOnlineUserNumInfo>
  9.         <LiveStreamOnlineUserNumInfo>
  10.             <StreamUrl>rtmp://test101.cdnpe.com/live/test102</StreamUrl>
  11.             <UserNumber>5</UserNumber>
  12.             <Time>2016-06-29T19:04:00Z</Time>
  13.         </LiveStreamOnlineUserNumInfo>
  14.     </OnlineUserInfo>
  15.     <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
  16.     <TotalUserNumber>7</TotalUserNumber>
  17.   </DescribeLiveStreamOnlineUserNumResponse>

最後更新：2016-11-23 17:16:03

  上一篇：go 查詢流控曆史__直播流操作接口_API 手冊_CDN-阿裏雲
  下一篇：go 禁止直播流推送__直播流操作接口_API 手冊_CDN-阿裏雲