全部產品
Search

搜尋本產品

    ApsaraVideo Live：DescribeCasters

    文件中心

    ApsaraVideo Live：DescribeCasters

    更新時間：Jun 23, 2026

    查詢導播台列表。

    介面說明

    先透過 CreateCaster 介面建立導播台，再呼叫本介面查詢導播台列表。導播台的狀態分為閒置和導播中。

    說明

    QPS 限制

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

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:DescribeCasters

    get

    *Caster

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地域 ID。

    cn-shanghai
    CasterId

    string

    否

    導播台 ID。

    • 如果您透過CreateCaste 介面建立導播台，請查看 CreateCaster 介面呼叫返回的參數 CasterId 值。

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

    說明

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

    • 若參數為空，預設返回所有導播台合併後的資料。

    LIVEPRODUCER_POST-cn-0pp1czt****
    CasterName

    string

    否

    導播台名稱。

    liveCaster****
    StartTime

    string

    否

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

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

    string

    否

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

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

    integer

    否

    頁碼。

    1
    PageSize

    integer

    否

    每頁範本數值，不傳預設為 100。

    100
    Status

    integer

    否

    狀態。取值：

    • 0：閒置。

    • 1：導播中。

    0
    ChargeType

    integer

    否

    付費方式。取值：

    • 0：PrePaid 預付費。

    • 1：PostPaid 後付費。

    0
    OrderByModifyAsc

    string

    否

    是否按照導播台的修改時間進行升序排序。

    有效值：true（按修改時間升序排列）| false（按修改時間降序排列，預設值）。

    說明

    不填預設為「false」。

    false
    NormType

    string

    否

    導播台規格類型。取值：

    • 1：通用型。

    • 3：輕量級輪播型。

    • 4：虛擬演播廳型。

    • 6：輪播台（新播單型導播台）。

    1
    ResourceGroupId

    string

    否

    資源群組 ID。關於資源群組的更多資訊，請參見什麼是資源群組。

    rg-aekzw******
    Tag

    array<object>

    否

    標籤列表。

    object

    否

    標籤列表。

    Key

    string

    否

    標籤鍵。

    TestKey
    Value

    string

    否

    標籤值。

    TestValue

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    導播台列表資訊查詢結果。

    CasterList

    object

    Caster

    array<object>

    導播台資訊列表。

    array<object>

    導播台資訊。

    CasterId

    string

    導播台 ID。可作為查詢導播台流地址、啟動導播台、添加導播台視頻資源、添加導播檯布局、查詢導播檯布局列表、添加導播台組件和添加導播台節目單的請求參數。

    LIVEPRODUCER_POST-cn-0pp1czt****
    CasterName

    string

    導播台名稱。

    liveCaster****
    CasterTemplate

    string

    導播台解析度配置，付費類型為預付費時必選。

    • lp_ld：流暢。

    • lp_sd：標清。

    • lp_hd：高清。

    • lp_ud：超清。

    • lp_ld_v：豎屏流暢。

    • lp_sd_v：豎屏標清。

    • lp_hd_v：豎屏高清。

    • lp_ud_v：豎屏超清。

    lp_ld
    ChannelEnable

    integer

    是否啟用 Channel。

    • 0：不啟用。

    • 1：啟用。

    1
    ChargeType

    string

    付費方式。

    • PrePaid：預付費。

    • PostPaid：後付費。

    PrePaid
    CreateTime

    string

    建立時間。

    2017-08-30T12:02:57Z
    Duration

    string

    時間長度。格式為：hh:mm:ss（時：分：秒）。

    1:02:33
    ExpireTime

    string

    導播台到期時間。

    2018-08-30T12:02:57Z
    LastModified

    string

    對導播台最新修改時間。例如：近期有對導播台進行過開啟，停止，修改配置等操作的時間。

    2021-12-01T05:08:45Z
    NormType

    integer

    導播台規格類型 。 取值：

    • 0：播單型。

    • 1：通用型。

    1
    PurchaseTime

    string

    導播台購買時間。

    2017-08-30T12:02:57Z
    StartTime

    string

    導播台啟動時間，當導播台處於導播中時輸出。

    2017-08-30T18:02:57Z
    Status

    integer

    狀態。取值：

    • 0：空閑。

    • 1：導播中。

    1
    ClientTokenId

    string

    使用者產生的請求 token，用於保證請求的等冪性。 該參數值可自訂，但是要保證在不同請求間唯一，最大值不超過 64 個 ASCII 字元。

    53200b81-b761-4c10-842a-a0726d97****

    Tags

    object

    tag

    array<object>

    標籤列表。

    object

    標籤。

    TagKey

    string

    標籤鍵。

    TestKey
    TagValue

    string

    標籤值。

    TestValue
    ResourceGroupId

    string

    資源群組 ID。關於資源群組的更多資訊，請參見什麼是資源群組。

    rg-acfmz******
    RequestId

    string

    請求 ID。

    5c6a2a0df228-4a64- af62-20e91b******
    Total

    integer

    導播台數量。

    1

    樣本

    正常返回樣本

    JSON格式

    {
  "CasterList": {
    "Caster": [
      {
        "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
        "CasterName": "liveCaster****",
        "CasterTemplate": "lp_ld",
        "ChannelEnable": 1,
        "ChargeType": "PrePaid",
        "CreateTime": "2017-08-30T12:02:57Z",
        "Duration": "1:02:33",
        "ExpireTime": "2018-08-30T12:02:57Z",
        "LastModified": "2021-12-01T05:08:45Z",
        "NormType": 1,
        "PurchaseTime": "2017-08-30T12:02:57Z",
        "StartTime": "2017-08-30T18:02:57Z",
        "Status": 1,
        "ClientTokenId": "53200b81-b761-4c10-842a-a0726d97****\n",
        "Tags": {
          "tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmz******"
      }
    ]
  },
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b******",
  "Total": 1
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidUserId.Malformed %s, please check userId.
    400 MissingParameter %s.
    400 InvalidParameter.Malformed There are invalid parameters: %s.
    400 InvalidParameter.Status %s, please check and try again.
    400 InvalidParameter.StartTime %s, please check and try again later.
    400 InvalidParameter.EndTime %s, please check and try again later.
    400 LiveServiceNotFound %s, please check and try again later.
    400 InvalidParameter.PageSize %s, please check and try again later.
    400 InvalidParameter.PageNum %s, please check and try again later.
    403 PermissionDenied %s, please check and try again later.

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

    變更歷史

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