エピソードリストを照会します。
操作説明
プレイリストを照会する前に、AddPlaylistItems 操作を呼び出してプレイリストに項目を追加する必要があります。
QPS 制限
この操作は、ユーザーあたり 10 QPS (クエリ/秒) に制限されています。 この制限を超えた API 呼び出しはスロットリングされます。 スロットリングがビジネスに影響を及ぼす可能性があるため、API 呼び出しは適切に計画してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:ListPlaylist |
get |
*Caster
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョン ID。 |
cn-shanghai |
| ProgramId |
string |
任意 |
プレイリストの ID。 このパラメーターを指定すると、指定されたプレイリストの情報のみが返されます。 このパラメーターを空のままにすると、ご利用のアカウントに属するすべてのプレイリストの情報が返されます。 AddPlaylistItems 操作によって返された ProgramId 値を使用します。 |
c09f3d63-eacf-4fbf-bd48-a07a6ba7**** |
| Page |
integer |
任意 |
ページ番号。 |
1 |
| PageSize |
integer |
任意 |
各ページで返すエントリ数。 |
20 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| ProgramList |
array<object> |
プレイリストのリスト。 |
|
|
object |
|||
| CasterId |
string |
プレイリストが属するプロダクションスタジオの ID。 この ID をリクエストパラメーターとして使用して、仮想スタジオのレイアウトを追加、削除、変更、または照会します。 |
casdfasdfasfdasdflkasjdflaj**** |
| DomainName |
string |
ストリーミングドメイン。 |
example.com |
| ProgramId |
string |
プレイリストの ID。 |
c09f3d63-eacf-4fbf-bd48-a07a6ba7**** |
| ProgramName |
string |
プレイリストの名前。 |
playlist1 |
| RepeatNumber |
integer |
最初の再生後にプレイリストがリピートする回数。 有効な値:
|
1 |
| Status |
integer |
プレイリストのステータス。 有効な値:
|
1 |
| RequestId |
string |
リクエスト ID。 |
5c6a2a0d-f228-4a64-af62-20e91b96**** |
| Total |
integer |
プレイリストの総数。 |
1 |
例
成功レスポンス
JSONJSON
{
"ProgramList": [
{
"CasterId": "casdfasdfasfdasdflkasjdflaj****",
"DomainName": "example.com",
"ProgramId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
"ProgramName": "playlist1",
"RepeatNumber": 1,
"Status": 1
}
],
"RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****",
"Total": 1
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidPageSize.Malformed | %s, please check and try again later. | |
| 400 | InvalidPageNum.Malformed | %s, please check and try again later. | |
| 400 | InvalidParameter.Malformed | There are invalid parameters: %s. | |
| 500 | InternalError | %s, please try again later. | |
| 404 | PlayListNotFound | %s, please check and try again later. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。