編輯節目單。
介面說明
本介面為全量編輯，主要用於編輯配置資訊或替換大量節目單項。
QPS 限制
本介面的單使用者 QPS 限制為 10 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:EditPlaylist |
update |
*Caster
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地區 ID。 |
cn-shanghai |
| ProgramId |
string |
是 |
節目單 ID。如果您通過 AddPlaylistItems 介面添加節目單項，請查看 AddPlaylistItems 介面調用返回的參數 ProgramId 值。 |
445409ec-7eaa-461d-8f29-4bec2eb9**** |
| ProgramItems |
string |
是 |
節目單項輸入列表。為 JSON 字串，更多資訊，請參見 InputProgramItem。 |
[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f****"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c****"}] |
| ProgramConfig |
string |
否 |
節目單項配置。更多資訊，請參見 ProgramConfig。 |
[{"RepeatNumber":"0","ProgramName":"my program"}] |
InputProgramItem
| 參數名稱 | 樣本值 | 類型 | 描述 |
| ItemName | item1 | String | 節目單項名稱。 |
| ResourceType | vod | String | 資源類型。取值： vod，暫時只支援點播資源。 |
| ResourceValue | 5f8809f2-3352-4d1f-a8f7-86f9429f**** | String | 資源 ID。 |
ProgramConfig
| 參數名稱 | 樣本值 | 類型 | 描述 |
| RepeatNumber | 0 | Integer | 播放完後重複繼續播放的次數。取值： 0（預設值）：不重複播放。 -1：一直迴圈重複。 其他正整數：播放完後重複繼續播放的次數。 |
| ProgramName | myprogram | String | 節目單名稱。 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| CasterId |
string |
導播台 ID。可作為添加回調和添加虛擬演播廳布局的請求參數。 |
0e94d1f4-1a65-445c-9dcf-de8b3b8d**** |
| Items |
object |
添加節目單項資訊列表。 |
|
| FailedItems |
array<object> |
添加失敗的節目單項列表。 |
|
|
object |
添加失敗的節目單項列表。 |
||
| ItemId |
string |
節目單項 ID。 |
c09f3d63-eacf-4fbf-bd48-a07a6ba7**** |
| ItemName |
string |
節目單項名稱。 |
item2 |
| SuccessItems |
array<object> |
添加成功的節目單項列表。 |
|
|
object |
添加成功的專案列表。 |
||
| ItemId |
string |
節目單項 ID。 |
c09f3d63-eacf-4fbf-bd48-a07a6ba7**** |
| ItemName |
string |
節目單項名稱。 |
item1 |
| ProgramId |
string |
節目單 ID。可作為刪除節目單，查詢節目單，啟動節目單，停止節目單的請求參數。 |
445409ec-7eaa-461d-8f29-4bec2eb9**** |
| RequestId |
string |
請求 ID。 |
5c6a2a0d-f228-4a64-af62-20e91b96**** |
樣本
正常返回樣本
JSON格式
{
"CasterId": "0e94d1f4-1a65-445c-9dcf-de8b3b8d****",
"Items": {
"FailedItems": [
{
"ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
"ItemName": "item2"
}
],
"SuccessItems": [
{
"ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
"ItemName": "item1"
}
]
},
"ProgramId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
"RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****"
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidProgramId.Malformed | %s, please check and try again later. | 參數ProgramId無效，請檢查後重試。 |
| 400 | PlayListIsEmpty | %s, please check and try again later. | 播放清單為空白，請檢查後重試。 |
| 400 | MissInputParams | %s, please check and try again later. | 參數缺失，請檢查後重試。 |
| 400 | InvalidCasterId.Malformed | %s, please check and try again later. | 參數CasterId無效，請檢查後重試。 |
| 400 | IncorrectPlaylistStatus.Inuse | %s, please check and try again later. | Playlist正在使用中，請檢查後重試。 |
| 400 | InvalidParameter.Malformed | There are invalid parameters: %s. | 存在無效參數：%s。 |
| 500 | InternalError | %s, please try again later. | 內部錯誤，請稍後重試。 |
| 404 | PlayListNotFound | %s, please check and try again later. | PlayList不存在，請檢查後重試。 |
| 404 | InvalidCaster.NotFound | %s, please check and try again later. | 導播台不存在，請檢查後重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。