即時查詢單路流狀態。
介面說明
先擷取直播網域名稱,再調用本介面即時查詢單路流狀態。關於不線上狀態(offline)的詳細資料,請根據推流回調返回的資料擷取,本介面不做細分。
QPS 限制
本介面的單使用者 QPS 限制為 100 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:DescribeLiveStreamState |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地區 ID。 |
cn-shanghai |
| DomainName |
string |
是 |
直播推流網域名稱或播流網域名稱。 |
demo.aliyundoc.com |
| AppName |
string |
是 |
直播流所屬應用程式名稱。您可在流管理頁面查看 AppName。 |
liveApp**** |
| StreamName |
string |
是 |
直播流名稱。您可在流管理頁面查看 StreamName。 |
liveStream**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| Type |
string |
推流接入的類型。取值:
|
push |
| RequestId |
string |
請求 ID。 |
CE6CD79D-0A98-1F22-A15F-FADA74DF2729 |
| StreamState |
string |
流狀態。取值:
|
online |
樣本
正常返回樣本
JSON格式
{
"Type": "push",
"RequestId": "CE6CD79D-0A98-1F22-A15F-FADA74DF2729",
"StreamState": "online"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParam | Parameter invalid. | 輸入參數不合法 |
| 500 | InternalError | The request processing has failed due to backend service exception. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。