使用ListRtcMPUTaskDetail查詢混流轉推任務參數明細-ApsaraVideo for Live-阿里雲 - ApsaraVideo Live

查詢混流轉推任務參數明細。

介面說明

本介面用於查詢混流轉推任務的參數明細，僅可查詢通過 API 建立的混流轉推任務。
分頁查詢時，查詢結果預設按照任務的更新時間倒序排列。

QPS 限制

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

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:ListRtcMPUTaskDetail

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
AppId	string	是	應用 ID。說明應用 ID 由大小寫字母、數字、底線、短劃線（-）組成，最大 64 字元。	yourAppId
TaskId	string	否	任務 ID。說明任務 ID 由大小寫字母、數字、底線、短劃線（-）組成，最大 55 字元。指定任務 ID 時，優先按任務 ID 查詢，返回結果為指定任務 ID 的旁路轉推任務的參數明細。	yourTaskId
PageSize	integer	否	單頁顯示記錄的數量，取值範圍：1~100。說明未指定任務 ID 時，需要指定 PageSize 與 PageNo 參數，此時會返回指定應用 ID 下所有旁路轉推任務參數明細的分頁查詢結果。	10
PageNo	integer	否	頁碼。	20

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	****3B-0E1A-586A-AC29-742247****
MPUTasks	array<object>	任務參數明細，參數明細格式與調用建立混流任務時的參數格式一致。
	array<object>
AppId	string	應用 ID。	yourAppId
ChannelId	string	頻道 ID。	yourChannelId
TaskId	string	任務 ID，此 ID 為旁路轉推任務的標識。	yourTaskId
MixMode	string	混流模式。取值： 0：單路轉推，不混流轉碼，僅轉推原始單路流，無需配置混流轉碼參數。 1（預設值）：混流轉碼轉推。	0
StreamURL	string	直播推流地址。	rtmp://example.com/live/stream****
MultiStreamURL	array<object>	多地址轉推參數。
	object
URL	string	直播推流地址。	rtmp://example.com/live/stream****
IsAliCdn	boolean	是否轉推到阿里雲 CDN。 false 為轉推非阿里雲 CDN。 true 為轉推阿里雲 CDN。	false
Region	string	請求的混流服務所在地區。取值： CN-Shanghai：上海。 AP-Singapore（預設值）：新加坡。 EMAA-Saudi：沙特。	CN-Shanghai
MaxIdleTime	string	空閑逾時時間，單位：秒說明若設定了此參數，則會在任務處於空閑狀態的時間長度大於 MaxIdleTime 時，自動停止該任務；若未設定此參數，則會在房間關閉後，立刻停止該任務。	10
SingleSubParams	object	單流轉推參數。
SourceType	string	單流轉推模式下視頻輸入資料流類型，當視頻流（StreamType=2）時有效。取值： camera（預設值）：網路攝影機。 shareScreen：螢幕畫面分享。	camera
StreamType	string	單流轉推模式下轉推流類型。取值： 0（預設值）：轉推原始流。 1：僅轉推音頻流。 2：僅轉推視頻流。	0
UserId	string	轉推使用者識別碼，一次只能轉推一路流。	yourSubUserId
TranscodeParams	object	混流轉碼轉推參數。
Background	object	混流全域背景圖。
RenderMode	string	子畫面輸出時的顯示模式： 0：縮放並顯示黑底。 1（預設）：裁剪。	1
URL	string	全域背景圖 URL。	yourImageUrl
EncodeParams	object	轉推輸出的編碼參數。
AudioOnly	string	是否為純音頻，取值： true：純音頻。 false（預設值）：非純音頻。	false
AudioBitrate	string	音頻碼率，單位：kbps。	128
AudioChannels	string	音頻聲道數，取值：1、2。	2
AudioSampleRate	string	音頻採樣率，單位：Hz。	44100
VideoCodec	string	視頻編碼格式。預設值 H.264。	H.264
VideoBitrate	string	視頻碼率，單位：kbps。	3500
VideoFramerate	string	視訊框架率，單位：fps。	25
VideoGop	string	視頻 GOP。	20
VideoHeight	string	視頻高，單位：px。	1000
VideoWidth	string	視頻寬，單位：px。	1920
EnhancedParam	string	編碼增強參數，JSON 字串，目前支援的可選配置包括 profile 與 preset。 profile：編碼層級。當視頻編碼格式為 H.264 時，profile 支援的可選值包括："baseline", "main", "high"。 preset：調節編碼速度和品質的平衡。preset 支援的可選值包括："ultrafast", "superfast", "veryfast", "faster", "fast", "medium", "slow", "slower", "veryslow" "placebo"。每個值代表了一種編碼速度與輸出視頻品質的策略，從"ultrafast"（極快，編碼速度優先）到"placebo"（追求極致品質，編碼極慢）。	{"profile": "high", "preset": "veryfast"}
Layout	object	視頻布局資訊。說明視頻轉碼時所指定的視頻布局資訊，包括布局座標(X，Y)，布局窗格(Width，Height)，疊放順序(ZOrder)；純音頻轉碼時，不包含視頻布局資訊。
UserPanes	array<object>	混流使用者窗格資訊。
	array<object>
UserInfo	object	混流使用者資訊。
SourceType	string	混流轉碼模模式下視頻輸入資料流類型，僅針對視頻流（StreamType=2）有效。取值： camera（預設值）：網路攝影機。 shareScreen：螢幕畫面分享。	camera
ChannelId	string	混流使用者所在的頻道 ID。	yourChannelId
UserId	string	混流使用者識別碼。	yourSubUserId
Height	string	窗格高，歸一化百分比。	0.2632
Width	string	窗格寬，歸一化百分比。	0.3564
X	string	座標 X，歸一化百分比。	0.2456
Y	string	座標 Y，歸一化百分比。	0.3789
ZOrder	string	疊放順序，0 為最底層，1 層在 0 層之上，以此類推。	0
BackgroundImageUrl	string	子畫面的背景圖 URL。當使用者關閉網路攝影機或未進入房間時，會在布局位置填充為此圖片。	yourImageUrl
RenderMode	string	子畫面輸出時的顯示模式，取值： 0：縮放並顯示黑底。 1（預設值）：裁剪。	1
UserInfos	array<object>	混流使用者資訊，不指定使用者則所有使用者混流。
	object
ChannelId	string	混流使用者所在的頻道 ID。	yourChannelId
UserId	string	混流使用者識別碼。	yourSubUserId
SourceType	string	混流轉碼模模式下視頻輸入資料流類型，僅針對視頻流（StreamType=2）有效。取值： camera（預設值）：網路攝影機 shareScreen：螢幕畫面分享。	camera
StreamType	string	混流轉碼模式下轉推流類型。取值： 0（預設值）：轉推原始流。 1：僅轉推音頻流。 2：僅轉推視頻流。	0
SeiParams	object	SEI 配置參數。
LayoutVolume	object	布局和音量 SEI，該參數內容為空白則表示攜帶預設的布局和音量 SEI。
FollowIdr	string	發送 IDR 主要畫面格時是否確保攜帶 SEI，取值： 0：不確保帶 SEI。 1：確保帶 SEI。	0
Interval	string	SEI 發送間隔，單位：毫秒。	1000
PassThrough	object	透傳 SEI。
FollowIdr	string	發送 IDR 主要畫面格時是否確保攜帶 SEI，取值： 0：不確保帶 SEI。 1：確保帶 SEI。	0
Interval	string	SEI 發送間隔，單位：毫秒。	1000
PayloadContent	string	透傳 SEI 的 payload 內容。	yourPayloadContent
PayloadContentKey	string	透傳 SEI 的 payload 內容對應的 key 值。不設定時，key 為預設值 udd。	yourPayloadContentKey
PayloadType	string	SEI 訊息的自訂 payload_type，取值範圍 100-254。不設定時，SEI 的 payload_type 為預設值為 5。	100

樣本

正常返回樣本

JSON格式

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "MPUTasks": [
    {
      "AppId": "yourAppId",
      "ChannelId": "yourChannelId",
      "TaskId": "yourTaskId",
      "MixMode": "0",
      "StreamURL": "rtmp://example.com/live/stream****",
      "MultiStreamURL": [
        {
          "URL": "rtmp://example.com/live/stream****",
          "IsAliCdn": false
        }
      ],
      "Region": "CN-Shanghai",
      "MaxIdleTime": "10",
      "SingleSubParams": {
        "SourceType": "camera",
        "StreamType": "0",
        "UserId": "yourSubUserId"
      },
      "TranscodeParams": {
        "Background": {
          "RenderMode": "1",
          "URL": "yourImageUrl"
        },
        "EncodeParams": {
          "AudioOnly": "false",
          "AudioBitrate": "128",
          "AudioChannels": "2",
          "AudioSampleRate": "44100",
          "VideoCodec": "H.264",
          "VideoBitrate": "3500",
          "VideoFramerate": "25",
          "VideoGop": "20",
          "VideoHeight": "1000",
          "VideoWidth": "1920",
          "EnhancedParam": "{\"profile\": \"high\", \"preset\": \"veryfast\"}"
        },
        "Layout": {
          "UserPanes": [
            {
              "UserInfo": {
                "SourceType": "camera",
                "ChannelId": "yourChannelId",
                "UserId": "yourSubUserId"
              },
              "Height": "0.2632",
              "Width": "0.3564",
              "X": "0.2456",
              "Y": "0.3789",
              "ZOrder": "0",
              "BackgroundImageUrl": "yourImageUrl",
              "RenderMode": "1"
            }
          ]
        },
        "UserInfos": [
          {
            "ChannelId": "yourChannelId",
            "UserId": "yourSubUserId",
            "SourceType": "camera",
            "StreamType": "0"
          }
        ]
      },
      "SeiParams": {
        "LayoutVolume": {
          "FollowIdr": "0",
          "Interval": "1000"
        },
        "PassThrough": {
          "FollowIdr": "0",
          "Interval": "1000",
          "PayloadContent": "yourPayloadContent",
          "PayloadContentKey": "yourPayloadContentKey"
        },
        "PayloadType": "100"
      }
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParam	%s.	參數校正失敗
400	InvalidAppId	%s, please check and try again later.	AppId無效，請檢查後重試。
400	MissingParam	%s, please check and try again later.	參數缺失，請檢查後重試。
500	InternalError	%s, please try again later.	內部錯誤，請稍後重試。
403	OperationDenied	Your account has not enabled the Live service
403	Forbidden	%s, please check and try again later.	無許可權，請檢查後重試。

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

變更歷史

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