調用StartCaster API啟動雲導播台-ApsaraVideo for Live-阿里雲 - ApsaraVideo Live

啟動導播台。若 PVW、PGM 場景不存在則建立，啟動 PVW、PGM 場景，啟動底層音影片處理任務。

介面說明

先透過 CreateCaster 介面建立導播台，再呼叫本介面啟動導播台。若 PVW、PGM 場景不存在則建立，啟動 PVW、PGM 場景，啟動底層音影片處理任務。

呼叫前，還需要先呼叫 SetCasterConfig 設定 DomainName，未設定時將返回 InvalidDomainName.NotFound。

QPS 限制

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:StartCaster

update

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地域 ID。	cn-shanghai
CasterId	string	是	導播台 ID。如果您透過 CreateCaster 介面建立導播台，請檢視 CreateCaster 介面呼叫返回的參數 CasterId 值。如果您透過直播主控台建立導播台，請透過直播主控台 > 導播台 > 雲端導播台頁面檢視。說明直播主控台雲端導播台頁面導播台清單中的導播台名稱即為導播台 ID。	80787064-1c94-4dc1-85ce-9409960a****

返回參數

名稱	類型	描述	樣本值
	object	導播台資訊。
PgmSceneInfos	object
SceneInfo	array<object>	PGM 場景資訊清單。
	array<object>	PGM 場景資訊清單。
SceneId	string	情境 ID。	b5f8c837-ceeb-424f-b30b-68e94e86****
StreamInfos	object
StreamInfo	array<object>	旁路輸出播放地址清單。
	object	旁路輸出播放地址清單。
OutputStreamUrl	string	播放地址。	rtmp://abclive/caster/example.net
TranscodeConfig	string	轉碼配置。取值： lsd：標清。 lld：流暢。 lud：超清。 lhd：高清。	lld
VideoFormat	string	格式。取值： flv。 rtmp。 m3u8。	flv
StreamUrl	string	導播台 PGM 情境對應播放流地址，非旁路輸出資料流地址。	rtmp://abclive/caster/example.edu
PvwSceneInfos	object
SceneInfo	array<object>	PVW 場景資訊清單。
	object	PVW 場景資訊清單。
SceneId	string	情境 ID。	b5f8c837-ceeb-424f-b30b-68e94e86****
StreamUrl	string	導播台 PVW 情境對應播放流地址，非旁路輸出資料流地址。	rtmp://abclive/caster/example.net
RequestId	string	請求 ID。	6EBD1AC4-C34D-4AE1-963E-B688A228BE31

樣本

正常返回樣本

JSON格式

{
  "PgmSceneInfos": {
    "SceneInfo": [
      {
        "SceneId": "b5f8c837-ceeb-424f-b30b-68e94e86****",
        "StreamInfos": {
          "StreamInfo": [
            {
              "OutputStreamUrl": "rtmp://abclive/caster/example.net",
              "TranscodeConfig": "lld",
              "VideoFormat": "flv"
            }
          ]
        },
        "StreamUrl": "rtmp://abclive/caster/example.edu"
      }
    ]
  },
  "PvwSceneInfos": {
    "SceneInfo": [
      {
        "SceneId": "b5f8c837-ceeb-424f-b30b-68e94e86****",
        "StreamUrl": "rtmp://abclive/caster/example.net"
      }
    ]
  },
  "RequestId": "6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidUserId.Malformed	%s, please check userId.	傳入的userId無效，請檢查。
400	InvalidCasterId.Malformed	%s, please check and try again later.	參數CasterId無效，請檢查後重試。
400	IncorrectSceneStatus	%s, please check and try again later.	Scene狀態不支援，請檢查後重試。
400	IncorrectCasterStatus.Inuse	%s, please check and try again later.	導播台狀態為已開啟，請檢查後重試。
400	IncorrectSceneStatus.Inuse	%s, please check and try again later.	Scene已開啟，請檢查後重試。
400	InvalidParameter.Malformed	There are invalid parameters: %s.	存在無效參數：%s。
400	IncorrectChannel.Disable	%s, please check and try again later.	Channel處於不可設置狀態，請檢查後重試。
400	IncorrectCasterStatus.Cease	%s, please check and try again later.	導播台已欠費停服，請結清後重試。
400	IncorrectCasterStatus.Expire	%s, please check and try again later.	導播台預付費執行個體過期，請續費後重試。
401	IllegalOperation	%s, please check and 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.	網域名稱不存在，請檢查後重試。
404	InvalidCasterTemplate.NotFound	%s, please check and try again later.	導播台範本不存在，請檢查後重試。
404	InvalidConfiguration.NotFound	%s, please check and try again later.	設定不存在，請檢查後重試。
404	InvalidResource.NotFound	%s, please check and try again later.	資源不存在，請檢查後重試。
404	InvalidTranscode.NotFound	%s, please check and try again later.	轉碼未配置，請檢查後重試。
404	InvalidDelay.NotFound	%s, please check and try again later.	延時播放未配置，請檢查後重試。

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

變更歷史

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