查詢導播台情境列表。
介面說明
先通過 CreateCaster 介面建立導播台,再調用本介面查詢導播台情境列表。
QPS 限制
本介面的單使用者 QPS 限制為 15 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:DescribeCasterScenes |
get |
*Caster
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地區 ID。 |
cn-shanghai |
| CasterId |
string |
是 |
導播台 ID。
說明
直播控制台雲導播台頁面導播台列表中的導播台名稱即導播台 ID。 |
80787064-1c94-4dc1-85ce-9409960a**** |
| SceneId |
string |
否 |
情境 ID。 |
b5f8c837-ceeb-424f-b30b-68e94e86**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
CF60DB6A-7FD6-426E-9288-122CC1***** |
| SceneList |
object |
||
| Scene |
array<object> |
情境資訊列表。 |
|
|
object |
情境資訊列表。 |
||
| ComponentIds |
object |
||
| componentId |
array |
組件 id 列表。 |
|
|
string |
組件 ID 列表。 |
["1506396160-0-0-7de771a77102680861853af862d5****"] |
|
| LayoutId |
string |
布局 ID。 |
37cb2f8b-f152-4338-b928-6704f71d**** |
| OutputType |
string |
是否正式輸出。 取值:
|
0 |
| SceneId |
string |
情境 ID。可作為更新情境音頻配置、查詢導播台情境音頻配置、啟動導播台情境和停止導播台情境的請求參數。 |
b5f8c837-ceeb-424f-b30b-68e94e86**** |
| SceneName |
string |
情境名稱。 |
scene1 |
| Status |
integer |
情境狀態。 取值:
|
0 |
| StreamInfos |
object |
||
| StreamInfo |
array<object> |
播放地址清單。 |
|
|
object |
播放地址清單。 |
||
| OutputStreamUrl |
string |
播放地址。 |
http://live/caster/example.net |
| TranscodeConfig |
string |
轉碼配置。取值:
|
lld |
| VideoFormat |
string |
格式。取值:
|
flv |
| StreamUrl |
string |
輸出資料流地址。 |
rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5**** |
| Total |
integer |
總記錄數。 |
2 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "CF60DB6A-7FD6-426E-9288-122CC1*****",
"SceneList": {
"Scene": [
{
"ComponentIds": {
"componentId": [
"[\"1506396160-0-0-7de771a77102680861853af862d5****\"]"
]
},
"LayoutId": "37cb2f8b-f152-4338-b928-6704f71d****",
"OutputType": "0",
"SceneId": "b5f8c837-ceeb-424f-b30b-68e94e86****",
"SceneName": "scene1",
"Status": 0,
"StreamInfos": {
"StreamInfo": [
{
"OutputStreamUrl": "http://live/caster/example.net",
"TranscodeConfig": "lld",
"VideoFormat": "flv"
}
]
},
"StreamUrl": "rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****"
}
]
},
"Total": 2
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidCasterId.Malformed | %s | |
| 400 | InvalidSceneId.Malformed | %s | |
| 401 | IllegalOperation | %s | |
| 500 | InternalError | %s | |
| 404 | InvalidCaster.NotFound | %s | |
| 404 | InvalidDomainName.NotFound | %s |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。