新增導播台節目單。
介面說明
請先建立導播台,新增導播台影片資源後再呼叫本介面新增導播台節目單。本介面目前僅支援影片來源和元件兩種節點類型。使用 API 建立導播台,請參見建立導播台。
QPS 限制
本介面的單一使用者 QPS 限制為每秒 10 次。超過限制時,API 呼叫會被限流,這可能會影響您的業務,請合理呼叫。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:AddCasterProgram |
create |
*Caster
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
| Episode |
array<object> |
是 |
節目單資訊。 |
|
|
object |
否 |
節目單資訊。 |
||
| ComponentId |
array |
否 |
元件清單。按照元素順序由下而上排列。 重要 當 Episode.N.EpisodeType 為 Component 時,本參數有效且為必填。
當節點類型為 Resource 時,表示元件與影片來源綁定並同步切換。 |
[ "a2b8e671-2fe5-4642-a2ec-bf931826****", "a2b8e671-2fe5-4642-a2ec-28374657****"] |
|
string |
否 |
元件 ID。 |
a2b8e671-2fe5-4642-a2ec-bf931826**** |
|
| EndTime |
string |
否 |
結束時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。必填,未填寫時返回 MissingParameter。 |
2016-06-29T10:02:00Z |
| EpisodeName |
string |
否 |
節目名稱。 |
program_name_1 |
| EpisodeType |
string |
否 |
節點類型。
說明
|
Resource |
| ResourceId |
string |
否 |
影片來源 ID。 重要 當 Episode.N.EpisodeType 為 Resource 時,本參數有效且為必填。
當 Episode.N.EpisodeType 為 Component 時,本參數不可用。 如果您透過 AddCasterVideoResource 介面新增導播台影片來源,請檢視 AddCasterVideoResource 介面呼叫返回的參數 ResourceId 值。 |
a2b8e671-2fe5-4642-a2ec-bf93880e**** |
| StartTime |
string |
否 |
起始時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。必填,未填寫時返回 MissingParameter。 |
2016-06-29T09:00:00Z |
| SwitchType |
string |
否 |
切換策略。取值: 重要 當 Episode.N.EpisodeType 為 Resource 時,本參數才有效。
|
TimeFirst |
| CasterId |
string |
是 |
導播台 ID。
說明
直播主控台雲端導播台頁面導播台清單中的導播台名稱即為導播台 ID。 |
LIVEPRODUCER_POST-cn-0pp1czt**** |
請求參數中的 N 表示第幾個的意思。例如:
Episode.N.EpisodeName 表示傳入第幾個節目名稱。Episode.1.EpisodeName 表示傳入第 1 個節目名稱,Episode.2.EpisodeName 表示傳入第 2 個節目名稱。
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| EpisodeIds |
object |
||
| EpisodeId |
array<object> |
節目 ID 清單,清單中元素順序與傳入節目順序保持一致。 |
|
|
object |
|||
| EpisodeId |
string |
節目組 ID。可作為修改導播台節目單,查詢導播台節目單,刪除導播台節目,修改導播台節目的請求參數。 |
16A96B9A-F203-4EC5-8E43-CB92E68F**** |
| RequestId |
string |
請求 ID。 |
16A96B9A-F203-4EC5-8E43-CB92E68F**** |
樣本
正常返回樣本
JSON格式
{
"EpisodeIds": {
"EpisodeId": [
{
"EpisodeId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}
]
},
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | MissingParameter | %s. | 參數缺失。 |
| 400 | InvalidParameter.Malformed | There are invalid parameters: %s. | 存在無效參數:%s。 |
| 400 | SwitchTypeInvalid.Malformed | %s, please check and try again later. | 參數SwitchType無效,請檢查後重試。 |
| 400 | IncorrectStartTime | %s, please check and try again later. | 參數StartTime無效,請檢查後重試。 |
| 400 | IncorrectEndTime | %s, please check and try again later. | 參數EndTime無效,請檢查後重試。 |
| 400 | EpisodeConflict.Malformed | %s, please check and try again later. | 節目時間存在衝突,請檢查後重試。 |
| 400 | InvalidCasterId.Malformed | %s, please check and try again later. | 參數CasterId無效,請檢查後重試。 |
| 400 | InvalidParameter.EndTime | %s, please check and try again later. | 參數EndTime無效,請檢查後重試。 |
| 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 | InvalidResource.NotFound | %s, please check and try again later. | 資源不存在,請檢查後重試。 |
| 404 | InvalidComponent.NotFound | %s, please check and try again later. | 待操作的元件不存在,請檢查後重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。