プレイリスト項目を追加します。
操作説明
プロダクションスタジオを作成し、プロダクションスタジオのレイアウトとコンポーネントを追加してから、この操作を呼び出してプレイリスト項目を追加します。プレイリストが作成されていない場合、システムによって自動的に作成されます。API オペレーションを使用してプロダクションスタジオを作成する方法については、「 CreateCaster 」をご参照ください。
QPS 制限
この操作の単一ユーザー QPS 制限は、1 秒あたり 10 回の呼び出しです。制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響が出る可能性があります。この操作は適切に呼び出してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:AddPlaylistItems |
create |
*Caster
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョン ID。 |
cn-shanghai |
| CasterId |
string |
必須 |
プロダクションスタジオの ID。
説明
ApsaraVideo Live コンソールのクラウドプロダクションスタジオページにあるプロダクションスタジオリスト内のプロダクションスタジオ名が、プロダクションスタジオの ID です。 プロダクションスタジオは、以下の構成を満たしている必要があります。
|
0e94d1f4-1a65-445c-9dcf-de8b3b8d**** |
| ProgramItems |
string |
必須 |
プレイリスト項目入力のリスト。値は JSON 文字列です。詳細については、「InputProgramItem」をご参照ください。 |
[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f****"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c****"}] |
| ProgramId |
string |
任意 |
プレイリストの ID。プロダクションスタジオにすでにプレイリストが存在する場合は、対応する ProgramId を指定する必要があります。プレイリストが作成されていない場合は、このパラメーターを空にすることができ、システムによって自動作成が実行されます。 |
445409ec-7eaa-461d-8f29-4bec2eb9**** |
| ProgramConfig |
string |
任意 |
プレイリスト項目の構成。初めてプレイリスト項目を追加する場合は、初期化のためにこのパラメーターを指定してください。詳細については、「ProgramConfig」をご参照ください。 |
[{"RepeatNumber":"0","ProgramName":"my program"}] |
InputProgramItem
| パラメーター | 例 | タイプ | 説明 |
| ItemName | item1 | String | プレイリスト項目の名前。 |
| ResourceType | vod | String | リソースタイプ。有効な値: vod: ApsaraVideo VOD リソース。 url: サードパーティのビデオリソース。 |
| ResourceValue | 5f8809f2-3352-4d1f-a8f7-86f9429f**** | String | ResourceType が vod に設定されている場合、ResourceValue はメディアアセット ID です。 ResourceType が url に設定されている場合、ResourceValue はサードパーティのビデオ URL です。 |
ProgramConfig
| パラメーター | 例 | タイプ | 説明 |
| RepeatNumber | 0 | Integer | プレイリスト終了後に再生を繰り返す回数。有効な値: 0 (デフォルト): 繰り返し再生なし。 -1: 無制限にループ。 その他の正の整数: プレイリスト終了後に再生を繰り返す回数。 |
| ProgramName | myprogram | String | プレイリスト名。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| Items |
object |
追加されたプレイリスト項目のリスト。 |
|
| FailedItems |
array<object> |
追加に失敗したプレイリスト項目のリスト。 |
|
|
object |
|||
| ItemId |
string |
プレイリストアイテムの ID。 |
c09f3d63-eacf-4fbf-bd48-a07a6ba7**** |
| ItemName |
string |
プレイリストアイテムの名前。 |
item1 |
| SuccessItems |
array<object> |
正常に追加されたプレイリスト項目のリスト。 |
|
|
object |
|||
| ItemId |
string |
プレイリストアイテムの ID。 |
c09f3d63-eacf-4fbf-bd48-a07a6ba7**** |
| ItemName |
string |
プレイリストアイテムの名前。 |
item2 |
| ProgramId |
string |
プレイリストの ID。この値は、プレイリスト項目の削除、プレイリスト項目の照会、プレイリストの編集、プレイリストの削除、プレイリストの照会、プレイリストの開始、およびプレイリストの停止のリクエストパラメーターとして使用できます。 |
445409ec-7eaa-461d-8f29-4bec2eb9**** |
| RequestId |
string |
リクエスト ID。 |
5c6a2a0d-f228-4a64-af62-20e91b96**** |
例
成功レスポンス
JSONJSON
{
"Items": {
"FailedItems": [
{
"ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
"ItemName": "item1"
}
],
"SuccessItems": [
{
"ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
"ItemName": "item2"
}
]
},
"ProgramId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
"RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidCasterId.Malformed | %s, please check and try again later. | CasterId パラメーターが無効です。パラメーターを確認して再試行してください。 |
| 400 | PlayListIsEmpty | %s, please check and try again later. | プレイリストが空です。プレイリストを確認して再試行してください。 |
| 400 | MissInputParams | %s, please check and try again later. | 必須パラメーターが不足しています。確認して再試行してください。 |
| 400 | InvalidProgramId.Malformed | %s, please check and try again later. | ProgramId パラメーターが無効です。パラメーターを確認して再試行してください。 |
| 400 | InvalidParameter.Malformed | There are invalid parameters: %s. | 次のパラメーターが無効です: %s。 |
| 500 | InternalError | %s, please try again later. | 内部エラーが発生しました。しばらくしてから再試行してください。 |
| 403 | UserQuotaExceed | Quota exceeded: %s. | クォータを超過しました: %s。 |
| 404 | InvalidCaster.NotFound | %s, please check and try again later. | プロダクションスタジオが存在しません。構成を確認して再試行してください。 |
| 404 | InvalidDomainName.NotFound | %s, please check and try again later. | ドメイン名が存在しません。ドメイン名を確認して再試行してください。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。