使用StartPlaylist API啟動節目單-ApsaraVideo for Live-阿里雲 - ApsaraVideo Live

啟動整個節目單。

介面說明

先通過 AddPlaylistItems 介面添加節目單項，再調用本介面啟動整個節目單。

QPS 限制

本介面的單使用者 QPS 限制為 10 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:StartPlaylist

update

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID。	cn-shanghai
ProgramId	string	是	節目單 ID。如果您通過 AddPlaylistItems 介面添加節目單項，請查看 AddPlaylistItems 介面調用返回的參數 ProgramId 值。	445409ec-7eaa-461d-8f29-4bec2eb9****
ResumeMode	string	否	重啟模式。取值： Restart：從頭開始。 Continue：根據停止前播放位置繼續。如果 ResumeMode 參數設定為 Custom 時，請求參數 StartItemId 才必填。 Custom：自訂。	Custom
StartItemId	string	否	起始節目單項 ID。啟動輪播時將先播放此節目單項。重要如果 ResumeMode 參數設定為 Custom 時，此參數才必傳。	asdfasdfasdf****
Offset	integer	否	啟動位移。視頻檔案起始位移值。僅對檔案視頻有效，單位：毫秒。大於 0，表示從相對於首幀的偏差時間作為開始讀取的位置。	10000

返回參數

名稱	類型	描述	樣本值
	object
ProgramId	string	節目單 ID。可作為停止節目單的請求參數。	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	請求 ID。	5c6a2a0d-f228-4a64-af62-20e91b96****
StreamInfo	object	返回的流資訊。
AppName	string	應用程式名稱。	liveApp****
DomainName	string	主播流網域名稱。	example.com
StreamName	string	播流名稱。	liveStream****
Streams	object
Stream	array<object>	流資訊列表。
	object
PullFlvUrl	string	FLV 播流地址。	http://aliyundoc.com/caster/liveStream**.flv?auth_key=1612772224-0-0-3632be7cd9907169e8b09e91099c**
PullM3U8Url	string	RTMP 播流地址。	rtmp:///aliyundoc.com/caster/liveStream**?auth_key=1612772224-0-0-4404ca59c0246226d49d01f734b1**
PullRtmpUrl	string	m3u8 播流地址。	http://aliyundoc.com/caster/liveStream**.m3u8?auth_key=1612772224-0-0-919a023a127156fe82e3562c3b3b**
Quality	string	畫質。取值： original：原畫。	original

樣本

正常返回樣本

JSON格式

{
  "ProgramId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****",
  "StreamInfo": {
    "AppName": "liveApp****",
    "DomainName": "example.com",
    "StreamName": "liveStream****",
    "Streams": {
      "Stream": [
        {
          "PullFlvUrl": "http://aliyundoc.com/caster/liveStream****.flv?auth_key=1612772224-0-0-3632be7cd9907169e8b09e91099c****",
          "PullM3U8Url": "rtmp:///aliyundoc.com/caster/liveStream****?auth_key=1612772224-0-0-4404ca59c0246226d49d01f734b1****",
          "PullRtmpUrl": "http://aliyundoc.com/caster/liveStream****.m3u8?auth_key=1612772224-0-0-919a023a127156fe82e3562c3b3b****",
          "Quality": "original"
        }
      ]
    }
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IncorrectSceneStatus	%s, please check and try again later.	Scene狀態不支援，請檢查後重試。
400	IncorrectCasterStatus	%s, please check and try again later.	導播台狀態有誤，請檢查後重試。
400	IncorrectSceneStatus.Inuse	%s, please check and try again later.	Scene已開啟，請檢查後重試。
400	InvalidProgramId.Malformed	%s, please check and try again later.	參數ProgramId無效，請檢查後重試。
400	InvalidParameter.Malformed	There are invalid parameters: %s.	存在無效參數：%s。
400	InvalidNormType.Malformed	%s, please check and try again later.	規格類型無效，請檢查後重試。
400	InvalidParameter.Offset	%s, please check and try again later.	參數Offset無效，請檢查後重試。
400	InvalidParameter.StartItemId	%s, please check and try again later.	參數StartItemId無效，請檢查後重試。
500	InternalError	%s, please try again later.	內部錯誤，請稍後重試。
403	UserQuotaExceed	Quota exceeded: %s.	超出配額：%s。
404	PlayListNotFound	%s, please check and try again later.	PlayList不存在，請檢查後重試。
404	PlayListItemNotFound	%s, please check and try again later.	PlayListItem不存在，請檢查後重試。
404	InvalidCaster.NotFound	%s, please check and try again later.	導播台不存在，請檢查後重試。
404	InvalidCasterTemplate.NotFound	%s, please check and try again later.	導播台模板不存在，請檢查後重試。
404	IncorrectCasterStatus.EnableChannel	%s, please check and try again later.	導播台狀態不支援EnableChannel設定，請檢查後重試。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。