プレイリストをクエリします。
操作説明
この操作を呼び出す前に、ショーをプレイリストに追加する必要があります。API 操作を呼び出してショーを追加する方法については、「プレイリストへのショーの追加」をご参照ください。
QPS 制限
1 人のユーザーが 1 秒あたりに実行できるクエリ数 (QPS) の上限は 10 です。上限を超えると、API 呼び出しはスロットリングされます。これはビジネス運用に影響を及ぼす可能性があります。適宜、呼び出しを計画してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:DescribeShowList |
get |
*Domain
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョン ID。 |
cn-shanghai |
| CasterId |
string |
必須 |
プロダクションスタジオの ID。
説明
[クラウドプロダクションスタジオ] ページのリストにあるプロダクションスタジオの名前が、プロダクションスタジオ ID です。 |
LIVEPRODUCER_POST-cn-0pp1czt**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| RequestId |
string |
リクエスト ID。 |
16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
| ShowList |
string |
プレイリストの詳細。 |
ShowList[Show1, Show2, Show3...] |
| ShowListInfo |
object |
プレイリスト。 |
|
| CurrentShowId |
string |
再生中のショーの ID。 |
a2b8e671-2fe5-4642-a2ec-bf93880e**** |
| Background |
string |
プレイリストのバックグラウンド。 |
{\"MaterialId\":\"a2b8e671-2fe5-4642-a2ec-bf93880e****\",\"resourceType\":\"VOD\"} |
| HighPriorityShowId |
string |
最優先のショー。 説明
このパラメーターは、プレイリストが開始される前にのみ設定できます。 |
a2b8e671-2fe5-4642-a2ec-bf93880e**** |
| HighPriorityShowStartTime |
string |
最優先のショーが再生される時間。フォーマットは yyyy-MM-dd'T'HH:mm:ss です。 説明
このパラメーターは、プレイリストが開始される前にのみ設定できます。設定が完了すると、指定された時間にシステムが最優先のショーに切り替わります。 |
2021-11-23T12:30:00 |
| ShowList |
object |
||
| Show |
array<object> |
プレイリスト内のショーのリスト。 |
|
|
array<object> |
ショーの詳細。 |
||
| Duration |
integer |
1 つのショーの再生時間 (秒単位)。 |
20 |
| RepeatTimes |
integer |
1 つのショーがループされる回数。 たとえば、値が 0 の場合はショーが 1 回再生されることを示します。値が 1 の場合はショーが 2 回再生されることを示します。 |
5 |
| ResourceInfo |
object |
リソース情報。 |
|
| LiveInputType |
integer |
カスタムタイプの識別子。 |
1 |
| ResourceId |
string |
ビデオオンデマンド (VOD) ファイルの ID。 |
a2b8e671-2fe5-4642-a2ec-bf93880e**** |
| ResourceType |
string |
リソース素材のタイプ。 |
vod |
| ResourceUrl |
string |
リソースの URL。 |
http://**/atestObject**.m3u8 |
| ShowId |
string |
ショーの ID。 |
a2b8e671-2fe5-4642-a2ec-bf93880e**** |
| ShowName |
string |
ショーの名前。 |
liveShow**** |
| ShowListRepeatTimes |
integer |
プレイリストのデフォルトのループ回数。この値は常に 0 です。 |
0 |
| TotalShowListRepeatTimes |
integer |
プレイリスト全体がループされる回数。 |
1 |
例
成功レスポンス
JSONJSON
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
"ShowList": "ShowList[Show1, Show2, Show3...]",
"ShowListInfo": {
"CurrentShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
"Background": "{\\\"MaterialId\\\":\\\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\\",\\\"resourceType\\\":\\\"VOD\\\"}",
"HighPriorityShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
"HighPriorityShowStartTime": "2021-11-23T12:30:00",
"ShowList": {
"Show": [
{
"Duration": 20,
"RepeatTimes": 5,
"ResourceInfo": {
"LiveInputType": 1,
"ResourceId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
"ResourceType": "vod",
"ResourceUrl": "http://**/atestObject**.m3u8"
},
"ShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
"ShowName": "liveShow****"
}
]
},
"ShowListRepeatTimes": 0,
"TotalShowListRepeatTimes": 1
}
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidUserId.Malformed | %s, please check userId. | |
| 400 | InvalidParameter.Malformed | There are invalid parameters: %s. | |
| 400 | InvalidCasterId.Malformed | %s, please check and try again later. | |
| 400 | MissingParameter | %s. | |
| 401 | IllegalOperation | %s, please check and try again later. | |
| 500 | InternalError | %s, please try again later. | |
| 404 | InvalidCaster.NotFound | %s, please check and try again later. | |
| 404 | InvalidShowList.NotFound | %s, please check and try again later. | |
| 404 | InvalidShow.NotFound | %s, please check and try again later. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。