查詢網域名稱下所有流的線上人數資訊。
介面說明
本介面目前只支援 FLV、RTS 和 RTMP 播放線上人數統計，暫不支援 HLS 播放線上人數統計。 資料擷取和統計有一定延遲，建議您查詢 5 分鐘前的資料。
請使用本介面替換原有的 DescribeLiveStreamOnlineUserNum（已廢棄）介面。
QPS 限制
本介面的單使用者 QPS 限制為 200 次/分鐘。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:DescribeLiveDomainOnlineUserNum |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地區 ID。 |
cn-shanghai |
| DomainName |
string |
是 |
主播流網域名稱。 |
example.com |
| QueryTime |
string |
否 |
查詢的時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。 |
2018-12-27T13:09:21Z |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
3A3A8C3D-F8B2-4FBF-9319-771A11B855FA |
| UserCount |
integer |
查詢時間下網域名稱的所有線上人數。 |
1 |
| StreamCount |
integer |
流數。 |
1 |
| OnlineUserInfo |
object |
||
| LiveStreamOnlineUserNumInfo |
array<object> |
流的資訊。 |
|
|
array<object> |
|||
| StreamName |
string |
流名稱。 |
rtmp://example.com/test/liveStream****_3_1 |
| Infos |
object |
||
| Info |
array<object> |
流統計資訊。 |
|
|
object |
|||
| UserNumber |
integer |
轉碼流或原始流的人數 |
1 |
| TranscodeTemplate |
string |
轉碼模板。origin 為原始流。 |
origin |
樣本
正常返回樣本
JSON格式
{
"RequestId": "3A3A8C3D-F8B2-4FBF-9319-771A11B855FA",
"UserCount": 1,
"StreamCount": 1,
"OnlineUserInfo": {
"LiveStreamOnlineUserNumInfo": [
{
"StreamName": "rtmp://example.com/test/liveStream****_3_1",
"Infos": {
"Info": [
{
"UserNumber": 1,
"TranscodeTemplate": "origin"
}
]
}
}
]
}
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InternalError | The request processing has failed due to backend service exception. | |
| 400 | InvalidQueryTime.Exceed | QueryTime exceed three month. | 查詢時間距離目前時間超過三個月。 |
| 400 | InvalidQueryTime.Malformed | Specified QueryTime is malformed. | 指定的查詢時間無效。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。