すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:DescribeLiveStreamMonitorList

    ドキュメントセンター

    ApsaraVideo Live:DescribeLiveStreamMonitorList

    最終更新日:Jan 13, 2026

    作成済みのモニタリングセッションのリストをクエリします。

    操作説明

    まず、モニタリングセッションを作成します。その後、この操作を呼び出してモニタリングセッションのリストを照会できます。この操作を呼び出す際は、必須パラメーターが設定されていることを確認してください。

    QPS 制限

    この操作は、ユーザーごとに毎秒 15 クエリ (QPS) に制限されています。この制限を超える API 呼び出しはスロットリングされます。これはビジネスに影響を与える可能性があるため、呼び出しを適切に計画してください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    live:DescribeLiveStreamMonitorList

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    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

    モニタリングアラートのしきい値の設定。値は、次のフィールドを含む JSON 文字列です：

    • fpsLowThres：ビデオフレームレートのアラートのしきい値。これは浮動小数点数です。

    • brHighThres：音声とビデオのビットレートのアラートのしきい値。これは浮動小数点数です。

    • eofDurationThresSec：ストリーム中断期間のアラートのしきい値。これは浮動小数点数です。

    "{\"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

    モニタリングアラート通知用の Webhook アドレス。

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

    integer

    レイアウト内の音声ソース。

    1
    DingTalkWebHookUrl

    string

    DingTalk チャットボットの 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

    入力ストリームの URL。

    demo.aliyundoc.com
    LayoutId

    integer

    レイアウト ID。値は 1 から始まる必要があります。

    1
    StreamName

    string

    モニタリング用のストリームの表示名。

    monitorStream****
    LayoutConfig

    object

    レイアウト情報。

    FillMode

    string

    フィルモード。フロントエンド開発では、このパラメーターを none に設定します。

    none
    PositionRefer

    string

    要素の位置の基準点。有効な値：

    • topLeft

    • topRight

    • bottomLeft

    • bottomRight

    topLeft
    PositionNormalized

    array

    [x,y] 形式の、要素の位置の正規化された座標。デフォルト値は [0,0] です。x と y の値は正規化されている必要があります。

    number

    [x,y] 形式の、要素のフィルエリアの位置。x と y の値は正規化されたパーセンテージです。
    例：[0.1,0.1] は、左上隅から水平方向に 10%、垂直方向に 10% のオフセットを示します。

    0.1
    SizeNormalized

    array

    [w,h] 形式の、要素のフィルエリアの正規化されたサイズ。

    number

    [w,h] 形式の、要素のフィルエリアのサイズ。w と h の値は正規化されたパーセンテージです。
    例：[0.2,0.3] は、水平方向の割合が 20%、垂直方向の割合が 30% であることを示します。

    0.3
    PlayConfig

    object

    再生設定。

    VolumeRate

    number

    音量。値は 0 から 1 の間で、小数点以下 2 桁までにする必要があります。

    0.50
    OutputUrls

    object

    モニタリング用の出力 URL。

    FlvUrl

    string

    FLV 形式の出力 URL。

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

    string

    RTMP 形式の出力 URL。

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

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidUserId.Malformed %s, please check userId.
    401 IllegalOperation %s, please check and try again later.
    500 InternalError %s, please try again later.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。