調用DescribeShowList介面查詢雲導播台的節目單-ApsaraVideo for Live-阿里雲 - ApsaraVideo Live

查詢節目單。

介面說明

請先添加節目後再調用本介面查詢節目單。使用 API 添加節目，請參見添加一個節目到節目單。

QPS 限制

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:DescribeShowList

get

*Domain

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID。	cn-shanghai
CasterId	string	是	導播台 ID。如果您通過 CreateCaster 介面建立導播台，請查看 CreateCaster 介面調用返回的參數 CasterId 值。如果您通過直播控制台建立導播台，請通過直播控制台 > 導播台 > 雲導播台路徑查看導播台名稱。說明直播控制台雲導播台頁面導播台列表中的導播台名稱即導播台 ID。	LIVEPRODUCER_POST-cn-0pp1czt****

返回參數

名稱	類型	描述	樣本值
	object	查詢節目單。
RequestId	string	請求 ID。	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
ShowList	string	ShowList 為播放清單的詳細資料。 Show 為節目單中的節目詳細資料，具體內容，請參見下表 Show。	ShowList[Show1, Show2, Show3...]
ShowListInfo	object	查詢節目單。
CurrentShowId	string	當前現正播放的節目 ID。	a2b8e671-2fe5-4642-a2ec-bf93880e****
Background	string	播單背景。	{\"MaterialId\":\"a2b8e671-2fe5-4642-a2ec-bf93880e****\",\"resourceType\":\"VOD\"}
HighPriorityShowId	string	最高優先順序節目。說明此配置只能在節目單未開始啟動前設定。	a2b8e671-2fe5-4642-a2ec-bf93880e****
HighPriorityShowStartTime	string	最高優先順序節目播放時間，格式為：yyyy-MM-dd'T'HH:mm:ss。說明此配置只能在節目單未開始啟動前設定。配置完成，節目單會在最高優先順序播放時間進行切播，開始播放最高優先順序節目（從當前現正播放的節目切播到最進階優先節目）。	2021-11-23T12:30:00
ShowList	object
Show	array<object>	播放清單的詳細資料。
	array<object>	播放清單的詳細資料。
Duration	integer	單個節目播放時間長度。單位：秒。	20
RepeatTimes	integer	單個節目播放的迴圈次數。 RepeatTimes 為重複次數，樣本：0 表示重複 0 次（實際播放 1 次），1 表示重複 1 次（實際播放 2 次），以此類推。	5
ResourceInfo	object	資源資訊。
LiveInputType	integer	自訂的類型標記。	1
ResourceId	string	點播檔案 ID。	a2b8e671-2fe5-4642-a2ec-bf93880e****
ResourceType	string	資源素材類型。	vod
ResourceUrl	string	資源 URL。	http:///atestObject.m3u8
ShowId	string	節目 ID。	a2b8e671-2fe5-4642-a2ec-bf93880e****
ShowName	string	播放節目名稱。	liveShow****
ShowListRepeatTimes	integer	播單預設迴圈次數。始終為 0。	0
TotalShowListRepeatTimes	integer	整個節目單播放的迴圈次數。	1

樣本

正常返回樣本

JSON格式

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "ShowList": "ShowList[Show1, Show2, Show3...]",
  "ShowListInfo": {
    "CurrentShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
    "Background": "{\\\"MaterialId\\\":\\\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\\",\\\"resourceType\\\":\\\"VOD\\\"}",
    "HighPriorityShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
    "HighPriorityShowStartTime": "2021-11-23T12:30:00",
    "ShowList": {
      "Show": [
        {
          "Duration": 20,
          "RepeatTimes": 5,
          "ResourceInfo": {
            "LiveInputType": 1,
            "ResourceId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
            "ResourceType": "vod",
            "ResourceUrl": "http://**/atestObject**.m3u8"
          },
          "ShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
          "ShowName": "liveShow****"
        }
      ]
    },
    "ShowListRepeatTimes": 0,
    "TotalShowListRepeatTimes": 1
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidUserId.Malformed	%s, please check userId.	傳入的userId無效，請檢查。
400	InvalidParameter.Malformed	There are invalid parameters: %s.	存在無效參數：%s。
400	InvalidCasterId.Malformed	%s, please check and try again later.	參數CasterId無效，請檢查後重試。
400	MissingParameter	%s.	參數缺失
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	InvalidShowList.NotFound	%s, please check and try again later.	ShowList不存在，請檢查後重試。
404	InvalidShow.NotFound	%s, please check and try again later.	Show不存在，請檢查後重試。

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

變更歷史

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