全部產品
Search

搜尋本產品

    ApsaraVideo Live：DescribeLiveStreamMonitorList - 查詢監播室列表

    文件中心

    ApsaraVideo Live：DescribeLiveStreamMonitorList - 查詢監播室列表

    更新時間：Apr 21, 2026

    查詢已建立的監播室列表。

    介面說明

    先建立監播室後再調用本介面查詢監播室列表，調用時請保證參數設定符合要求。

    QPS 限制

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

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:DescribeLiveStreamMonitorList

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地區 ID。

    cn-shanghai
    MonitorId

    string

    否

    監播室 ID。

    說明

    通過查看 CreateLiveStreamMonitor 介面的返回參數擷取 MonitorId 值。若參數為空白，預設返回所有監播室合并後的資料。

    445409ec-7eaa-461d-8f29-4bec2eb9****
    PageNum

    integer

    否

    當前頁數值。

    2
    PageSize

    integer

    否

    每頁監播室數值個數。

    10
    Status

    integer

    否

    監播室內狀態。取值：

    • 1：監播中。

    • 0：未監播。

    1
    OrderRule

    integer

    否

    啟動時間順序。取值：

    • 0：預設（按啟動狀態倒序，啟動時間不參與排序）。

    • 1：啟動時間倒序。

    • 2：啟動時間正序。

    1

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Total

    integer

    數量。

    1
    RequestId

    string

    請求 ID。

    2234baba-a586-46ea-8bd4-c8f7891abcdef
    LiveStreamMonitorList

    array<object>

    監播室列表。

    array<object>

    MonitorConfig

    string

    監播警示閾值設定。參數欄位如下：

    • fpsLowThres：視訊框架率警示閾值，Float 類型。

    • brHighThres：音視頻碼率警示閾值，Float 類型。

    • eofDurationThresSec：斷流時間長度檢測閾值，Float 類型。

    "{\"fpsLowThres\": 0.6,\"brLowThres\": 1.1,\"eofDurationThresSec\": 10}"
    Status

    integer

    監播室內狀態。取值：

    • 1：監播中。

    • 0：未監播。

    1
    MonitorId

    string

    監播室 ID。

    445409ec-7eaa-461d-8f29-4bec2eb9****
    Domain

    string

    監播輸出網域名稱。

    demo.aliyundoc.com
    CallbackUrl

    string

    監播警示通知回調地址。

    http://guide.aliyundoc.com/notify
    AudioFrom

    integer

    布局聲音來源。

    1
    DingTalkWebHookUrl

    string

    釘群機器人 URL。

    https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa****
    MonitorName

    string

    監播室名稱。

    liveMonito****
    StopTime

    string

    停止監播時間，UTC 格式。

    2017-01-11T12:00:00Z
    StartTime

    string

    開始監播時間，UTC 格式。

    2017-01-11T12:00:00Z
    OutputTemplate

    string

    監播輸出解析度模板。類型取值：

    • lp_ld：流暢。

    • lp_sd：標清。

    • lp_hd：高清。

    • lp_ud：超清。

    lp_ud
    Region

    string

    地區。取值：

    • cn-shanghai：上海。

    • cn-beijing：北京。

    • ap-southeast-1：新加坡。

    cn-shanghai
    InputList

    array<object>

    監控流輸入列表。

    array<object>

    Index

    integer

    索引，前端使用。

    1
    InputUrl

    string

    輸入資料流地址。

    demo.aliyundoc.com
    LayoutId

    integer

    布局 ID，必須從 1 開始。

    1
    StreamName

    string

    監播流的顯示名稱。

    monitorStream****
    LayoutConfig

    object

    布局資訊。

    FillMode

    string

    填滿類型，前端填 none 即可。

    none
    PositionRefer

    string

    設定元素的 position 參考座標值，取值：

    • topLeft

    • topRight

    • bottomLeft

    • bottomRight

    topLeft
    PositionNormalized

    array

    位置歸一化值[unk][x,y][unk]，預設為[unk][0,0][unk]。>x，y 需要進行歸一化計算。

    number

    表示該 Layer 元素填充區位置[x,y]，x 和 y 歸一化百分比。
    例如[0.1,0.1]代表左上方水平位移 10%, 垂直位移 10%。

    0.1
    SizeNormalized

    array

    字幕檔案大小，單位為位元組。

    number

    Layer 元素需要填充的尺寸大小[w,h]，w 和 h 歸一化百分比。
    例如[0.2,0.3]代表水平佔比 20%，垂直佔比 30%。

    0.3
    PlayConfig

    object

    播放配置。

    VolumeRate

    number

    音量。取值 0~1 之間，精確小數點後 2 位。

    0.50
    OutputUrls

    object

    監播輸出地址。

    FlvUrl

    string

    FLV 輸出地址。

    http://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****.flv
    RtmpUrl

    string

    RTMP 輸出地址。

    rtmp://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****

    樣本

    正常返回樣本

    JSON格式

    {
  "Total": 1,
  "RequestId": "2234baba-a586-46ea-8bd4-c8f7891abcdef",
  "LiveStreamMonitorList": [
    {
      "MonitorConfig": "\"{\\\"fpsLowThres\\\": 0.6,\\\"brLowThres\\\": 1.1,\\\"eofDurationThresSec\\\": 10}\"",
      "Status": 1,
      "MonitorId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
      "Domain": "demo.aliyundoc.com",
      "CallbackUrl": "http://guide.aliyundoc.com/notify",
      "AudioFrom": 1,
      "DingTalkWebHookUrl": "https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa****",
      "MonitorName": "liveMonito****",
      "StopTime": "2017-01-11T12:00:00Z",
      "StartTime": "2017-01-11T12:00:00Z",
      "OutputTemplate": "lp_ud",
      "Region": "cn-shanghai",
      "InputList": [
        {
          "Index": 1,
          "InputUrl": "demo.aliyundoc.com",
          "LayoutId": 1,
          "StreamName": "monitorStream****",
          "LayoutConfig": {
            "FillMode": "none",
            "PositionRefer": "topLeft",
            "PositionNormalized": [
              0.1
            ],
            "SizeNormalized": [
              0.3
            ]
          },
          "PlayConfig": {
            "VolumeRate": 0.5
          }
        }
      ],
      "OutputUrls": {
        "FlvUrl": "http://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****.flv",
        "RtmpUrl": "rtmp://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****"
      }
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidUserId.Malformed %s, please check userId. 傳入的userId無效，請檢查。
    401 IllegalOperation %s, please check and try again later. 不允許的操作，請檢查後重試。
    500 InternalError %s, please try again later. 內部錯誤，請稍後重試。

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

    變更歷史

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