全部產品
Search

搜尋本產品

    ApsaraVideo Live：ListPlaylist - 擷取播放清單

    文件中心

    ApsaraVideo Live：ListPlaylist - 擷取播放清單

    更新時間：Apr 21, 2026

    查詢節目單。

    介面說明

    先通過 AddPlaylistItems 介面添加節目單項，再調用本介面查詢節目單。

    QPS 限制

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

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:ListPlaylist

    get

    *Caster

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地區 ID。

    cn-shanghai
    ProgramId

    string

    否

    節目單 ID。如果填此參數，則返回該節目單資訊。若不填，預設返回該使用者所有節目單資訊。 如果您通過 AddPlaylistItems 介面添加節目單項，請查看 AddPlaylistItems 介面調用返回的參數 ProgramId 值。

    c09f3d63-eacf-4fbf-bd48-a07a6ba7****
    Page

    integer

    否

    查詢分頁頁數。

    1
    PageSize

    integer

    否

    查詢分頁每頁數量。

    20

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    ProgramList

    array<object>

    節目單資訊列表。

    object

    CasterId

    string

    節目單對應導播台 ID。可作為添加虛擬演播廳布局、刪除虛擬演播廳布局、修改虛擬演播廳布局和查詢虛擬演播廳布局的請求參數。

    casdfasdfasfdasdflkasjdflaj****
    DomainName

    string

    主播流網域名稱。

    example.com
    ProgramId

    string

    節目單 ID。

    c09f3d63-eacf-4fbf-bd48-a07a6ba7****
    ProgramName

    string

    節目單名稱。

    playlist1
    RepeatNumber

    integer

    播放完後繼續重複播放的次數。取值：

    • 0（預設值）：不重複播放。

    • -1：一直迴圈重複。

    • 其他正整數：播放完 1 遍後繼續重複播放的次數。

    1
    Status

    integer

    節目單狀態。取值：

    • 0：停止。

    • 1：運行。

    1
    RequestId

    string

    請求 ID。

    5c6a2a0d-f228-4a64-af62-20e91b96****
    Total

    integer

    節目單數量。

    1

    樣本

    正常返回樣本

    JSON格式

    {
  "ProgramList": [
    {
      "CasterId": "casdfasdfasfdasdflkasjdflaj****",
      "DomainName": "example.com",
      "ProgramId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
      "ProgramName": "playlist1",
      "RepeatNumber": 1,
      "Status": 1
    }
  ],
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****",
  "Total": 1
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidPageSize.Malformed %s, please check and try again later. 參數PageSize無效，請檢查後重試。
    400 InvalidPageNum.Malformed %s, please check and try again later. 參數PageNum無效，請檢查後重試。
    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不存在，請檢查後重試。

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

    變更歷史

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