全部產品
Search

搜尋本產品

    ApsaraVideo Live：DescribeCasterProgram - 查詢導播台節目單

    文件中心

    ApsaraVideo Live：DescribeCasterProgram - 查詢導播台節目單

    更新時間：Apr 21, 2026

    查詢導播台節目單。

    介面說明

    調用本介面查詢導播台節目單，本介面目前支援的節點類型為視頻源和組件。

    QPS 限制

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

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:DescribeCasterProgram

    get

    *Caster

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地區 ID。

    cn-shanghai
    CasterId

    string

    是

    導播台 ID。

    • 如果您通過 CreateCaster 介面建立導播台，請查看 CreateCaster 介面調用返回的參數 CasterId 值。

    • 如果您通過直播控制台建立導播台，請通過直播控制台 > 導播台 > 雲導播台頁面查看。

    說明

    直播控制台雲導播台頁面導播台列表中的導播台名稱即導播台 ID。

    LIVEPRODUCER_POST-cn-0pp1czt****
    EpisodeId

    string

    否

    節目 ID。

    1872639A-F203-4EC5-8E43-CB92E68F****
    EpisodeType

    string

    否

    節點類型。取值：

    • Resource：視頻源。

    • Component：組件。

    Resource
    StartTime

    string

    否

    起始時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    2016-06-29T09:00:00Z
    EndTime

    string

    否

    結束時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    2016-06-29T10:00:00Z
    PageNum

    integer

    否

    頁碼。

    5
    PageSize

    integer

    否

    每頁節目數量。

    10
    Status

    integer

    否

    節目狀態。 取值：

    • 0：未播放。

    • 1：播放中。

    • 2：播放完畢。

    0

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    CasterId

    string

    導播台 ID。

    LIVEPRODUCER_POST-cn-0pp1czt****
    Episodes

    object

    Episode

    array<object>

    節點列表。

    array<object>

    節點列表。

    ComponentIds

    object

    ComponentId

    array

    組件列表。

    string

    組件列表。

    ["1872639A-F203-4EC5-8E43-CB929282****" ]
    EndTime

    string

    結束時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    2016-06-29T10:02:00Z
    EpisodeId

    string

    節目 ID。

    1872639A-F203-4EC5-8E43-CB92E68F****
    EpisodeName

    string

    節目名稱。

    program_name_1
    EpisodeType

    string

    節點類型。 取值：

    • Resource：視頻源。

    • Component：組件。

    Resource
    ResourceId

    string

    視頻源 ID。

    1872639A-F203-4EC5-8E43-CB92E837****
    StartTime

    string

    起始時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    2016-06-29T09:00:00Z
    Status

    integer

    節目狀態。

    0
    SwitchType

    string

    切換策略。取值：

    • TimeFirst：時間優先，直播節目只允許採用時間優先。

    • ContentFirst：內容優先。

    TimeFirst
    ProgramEffect

    integer

    啟用標誌。

    • 0：不啟用 。

    • 1：啟用。

    1
    ProgramName

    string

    節目單名稱。

    programs_name
    RequestId

    string

    請求 ID。

    16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
    Total

    integer

    總記錄數。

    1

    樣本

    正常返回樣本

    JSON格式

    {
  "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
  "Episodes": {
    "Episode": [
      {
        "ComponentIds": {
          "ComponentId": [
            "[\"1872639A-F203-4EC5-8E43-CB929282****\" ]"
          ]
        },
        "EndTime": "2016-06-29T10:02:00Z",
        "EpisodeId": "1872639A-F203-4EC5-8E43-CB92E68F****",
        "EpisodeName": "program_name_1",
        "EpisodeType": "Resource",
        "ResourceId": "1872639A-F203-4EC5-8E43-CB92E837****",
        "StartTime": "2016-06-29T09:00:00Z",
        "Status": 0,
        "SwitchType": "TimeFirst"
      }
    ]
  },
  "ProgramEffect": 1,
  "ProgramName": "programs_name",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "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。
    400 InvalidCasterId.Malformed %s, please check and try again later. 參數CasterId無效，請檢查後重試。
    500 InternalError %s, please try again later. 內部錯誤，請稍後重試。
    500 InvalidParameter.Status %s, please check and try again later. 參數Status無效，請檢查後重試。
    404 InvalidCaster.NotFound %s, please check and try again later. 導播台不存在，請檢查後重試。

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

    變更歷史

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