查詢指定域名或者指定域名下某個應用的所有線上串流資訊。
介面說明
本介面目前支援以下幾種串流類型：
-
all：查詢所有串流。
-
raw：查詢原始流。
-
trans：查詢轉碼流。
QPS 限制
本介面的單一使用者 QPS 限制為 10000 次/分鐘。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理呼叫。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:DescribeLiveStreamsOnlineList |
get |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
| DomainName |
string |
是 |
主播流域名。 說明
|
example.com |
| AppName |
string |
否 |
播流所屬應用名稱。您可在串流管理頁面查看 AppName。 |
liveApp**** |
| StreamName |
string |
否 |
播流名稱，僅支援輸入單個 StreamName。您可在串流管理頁面查看 StreamName。 |
liveStream**** |
| OnlyStream |
string |
否 |
是否只傳回指定欄位。取值：
|
no |
| PageSize |
integer |
否 |
每頁大小。取值範圍：1~3000，預設值為 2000。 |
1500 |
| PageNum |
integer |
否 |
目前頁碼。預設值為 1。 |
1 |
| StreamType |
string |
否 |
串流類型。取值：
枚舉值：
|
all |
| QueryType |
string |
否 |
指定是否模糊比對串流名稱。取值：
枚舉值：
|
fuzzy |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
線上串流資訊。 |
||
| RequestId |
string |
請求 ID。 |
5c6a2a0df228-4a64- af62-20e91b9676b3 |
| TotalPage |
integer |
總頁數。 |
2 |
| PageNum |
integer |
分頁的頁碼。 |
1 |
| PageSize |
integer |
每頁顯示的筆數。 |
10 |
| TotalNum |
integer |
符合條件的總筆數。 |
11 |
| OnlineInfo |
object |
||
| LiveStreamOnlineInfo |
array<object> |
正在推送串流的資訊。 |
|
|
object |
正在推送串流的資訊。 |
||
| AudioDataRate |
integer |
直播流的音頻碼率。單位：Kbps。 說明
此參數需提交工單添加白名單配置後開啟，關於如何提交工單，請參見聯絡我們。 |
600 |
| FrameRate |
integer |
幀率。單位：FPS。 |
15 |
| PublishUrl |
string |
推流完整 URL 地址。 |
rtmp://demo.aliyundoc.com/live/test**** |
| StreamName |
string |
播流名稱。 |
liveStream**** |
| AudioCodecId |
integer |
音頻 Codec ID。 |
10 |
| Height |
integer |
視頻解析度高度。單位：pixel。 |
720 |
| VideoDataRate |
integer |
直播流的視頻碼率。單位：Kbps。 說明
此參數需提交工單添加白名單配置後開啟，關於如何提交工單，請參見聯絡我們。 |
600 |
| DomainName |
string |
主播流網域名稱。 |
example.com |
| PublishDomain |
string |
推流網域名稱，使用中心推流的可直接填寫播流網域名稱。 |
demo.aliyundoc.com |
| PublishTime |
string |
開始推流時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。 |
2021-08-09T02:37:59Z |
| AppName |
string |
播流所屬應用程式名稱。 |
liveApp**** |
| PublishType |
string |
推流類型，取值：
|
edge |
| VideoCodecId |
integer |
視頻 Codec ID。 |
7 |
| Transcoded |
string |
是否是轉碼流。取值：
|
no |
| Width |
integer |
視頻解析度寬度。單位：pixel。 |
1280 |
| ClientIp |
string |
推流用戶端 IP。 |
106.11.XX.XX |
| ServerIp |
string |
推流節點 IP。 |
120.221.XX.XX |
樣本
正常返回樣本
JSON格式
{
"RequestId": "5c6a2a0df228-4a64- af62-20e91b9676b3",
"TotalPage": 2,
"PageNum": 1,
"PageSize": 10,
"TotalNum": 11,
"OnlineInfo": {
"LiveStreamOnlineInfo": [
{
"AudioDataRate": 600,
"FrameRate": 15,
"PublishUrl": "rtmp://demo.aliyundoc.com/live/test****",
"StreamName": "liveStream****",
"AudioCodecId": 10,
"Height": 720,
"VideoDataRate": 600,
"DomainName": "example.com",
"PublishDomain": "demo.aliyundoc.com",
"PublishTime": "2021-08-09T02:37:59Z",
"AppName": "liveApp****",
"PublishType": "edge",
"VideoCodecId": 7,
"Transcoded": "no",
"Width": 1280,
"ClientIp": "106.11.XX.XX",
"ServerIp": "120.221.XX.XX"
}
]
}
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | QpsOverLimit | Qps is over limit for this domainName. | |
| 400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | |
| 400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | |
| 400 | InvalidEndTime.Mismatch | Specified end time does not match the specified start time. | |
| 400 | Duration.Exceed | Duration between StartTime and EndTime is too long. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。