Query MPU Task Details via ListRtcMPUTaskDetail - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries the parameter details of a stream mixing and relaying task.

Operation description

This operation queries the parameter details of a stream mixing and relaying task. Only stream mixing and relaying tasks created by using API operations can be queried.
For a paged query, the query results are sorted by task update time in descending order by default.

QPS limit

The single-user QPS limit for this operation is 50 calls per second. If the limit is exceeded, the API invocation is throttled, which may affect your business. Invoke this operation as needed.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:ListRtcMPUTaskDetail

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID. Note The application ID consists of uppercase and lowercase letters, digits, underscores, and hyphens (-), with a maximum of 64 characters.	yourAppId
TaskId	string	No	The task ID. Note The task ID consists of uppercase and lowercase letters, digits, underscores, and hyphens (-), with a maximum of 55 characters. If you specify a task ID, the query is performed based on the task ID first, and the result contains the parameter details of the stream mixing and relaying task with the specified task ID.	yourTaskId
PageSize	integer	No	The number of records per page. Valid values: 1 to 100. Note If you do not specify a task ID, you must specify the PageSize and PageNo parameters. In this case, the paged query results of all stream mixing and relaying tasks under the specified application ID are returned.	10
PageNo	integer	No	The page number. Note If you do not specify a task ID, you must specify the PageSize and PageNo parameters. In this case, the paged query results of all stream mixing and relaying tasks under the specified application ID are returned.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
MPUTasks	array<object>	The task parameter details. The parameter format is the same as the parameter format used when you call the operation to create a stream mixing task.
	array<object>
AppId	string	The application ID.	yourAppId
ChannelId	string	The channel ID.	yourChannelId
TaskId	string	The task ID. This ID is the identifier of the stream mixing and relaying task.	yourTaskId
MixMode	string	The stream mixing mode. Valid values: 0: single-stream relaying without stream mixing or transcoding. Only the original single stream is relayed. You do not need to configure stream mixing and transcoding parameters. 1 (default): stream mixing, transcoding, and relaying.	0
StreamURL	string	The live stream ingest URL.	rtmp://example.com/live/stream****
MultiStreamURL	array<object>	The multi-address relaying parameters.
	object
URL	string	The ingest URL.	rtmp://example.com/live/stream****
IsAliCdn	boolean	Indicates whether stream relay is performed by using Alibaba Cloud CDN. Valid values: false: Stream relay is performed by using a CDN service that is not Alibaba Cloud CDN. true: Stream relay is performed by using Alibaba Cloud CDN.	false
Region	string	The region where the requested stream mixing service resides. Valid values: CN-Shanghai: Shanghai. AP-Singapore (default): Singapore. EMAA-Saudi: Saudi Arabia.	CN-Shanghai
MaxIdleTime	string	The idle timeout period. Unit: seconds. Note If this parameter is set, the task is automatically stopped when the task has been idle for a period longer than MaxIdleTime. If this parameter is not set, the task is stopped immediately after the channel is closed.	10
SingleSubParams	object	The single-stream relaying parameters.
SourceType	string	The source of the video. This parameter is valid only if you set StreamType to 2. Valid values: camera (default): captures the video by using a camera. shareScreen: captures the content displayed on a screen.	camera
StreamType	string	The type of the stream that is relayed. Valid values: 0 (default): the original stream. 1: the audio-only stream. 2: the video-only stream.	0
UserId	string	The ID of the user whose stream is relayed. In single-stream relay mode, you can relay only one stream in a request.	yourSubUserId
TranscodeParams	object	The stream mixing, transcoding, and relaying parameters.
Background	object	The global background image.
RenderMode	string	The display mode. Valid values: 0: proportionally scales the video or background image to fit the pane. Black bars are added to fill the extra space. 1 (default): crops the video or background image to fit the pane.	1
URL	string	The URL of the global background image.	yourImageUrl
EncodeParams	object	The encoding parameters of the output stream.
AudioOnly	string	Indicates whether the output stream is an audio-only stream. Valid values: true false (default)	false
AudioBitrate	string	The bitrate of the audio. Unit: Kbit/s.	128
AudioChannels	string	The number of audio channels. Valid values: 1 and 2.	2
AudioSampleRate	string	The audio sampling rate. Unit: Hz.	44100
VideoCodec	string	The video encoding format. Default value: H.264.	H.264
VideoBitrate	string	The bitrate of the video. Unit: Kbit/s.	3500
VideoFramerate	string	The frame rate of the video. Unit: frames per second (FPS).	25
VideoGop	string	The group of pictures (GOP) size of the video.	20
VideoHeight	string	The height of the video. Unit: pixels.	1000
VideoWidth	string	The width of the video. Unit: pixels.	1920
EnhancedParam	string	The parameter for advanced video encoding. The value is a JSON string. Optional fields: profile: the encoding level. If the video encoding format is set to H.264, the valid values of this field are baseline, main, and high. preset: adjusts the trade-off between encoding speed and video quality. Valid values: ultrafast, superfast, veryfast, faster, fast, medium, slow, slower, veryslow, and placebo. Each value specifies a level of trade-off between encoding speed and video quality. For example, the ultrafast preset has the fastest encoding speed but the lowest video quality, while the placebo preset sacrifices the encoding speed for the best video quality.	{"profile": "high", "preset": "veryfast"}
Layout	object	The video layout information. Note The video layout information includes the x-coordinate, y-coordinate, width, height, and layer of the pane. For audio-only transcoding, no video layout information is returned.
UserPanes	array<object>	The information about the panes.
	array<object>
UserInfo	object	The information about the user whose stream is played in the pane.
SourceType	string	The source of the video. This parameter is valid only if you set StreamType to 2. Valid values: camera (default): captures the video by using a camera. shareScreen: captures the content displayed on a screen.	camera
ChannelId	string	The ID of the channel where the user is.	yourChannelId
UserId	string	The ID of the user.	yourSubUserId
Height	string	The height of the pane. The value is normalized.	0.2632
Width	string	The width of the pane. The value is normalized.	0.3564
X	string	The x-coordinate of the pane. The value is normalized.	0.2456
Y	string	The y-coordinate of the pane. The value is normalized.	0.3789
ZOrder	string	The layer of the pane. A value of 0 indicates that the pane is placed at the bottom layer. A larger value indicates a higher layer.	0
BackgroundImageUrl	string	The URL of the background image of the pane. This image is displayed if the user turns off the camera or is not present in the channel.	yourImageUrl
RenderMode	string	The display mode. Valid values: 0: proportionally scales the video or background image to fit the pane. Black bars are added to fill the extra space. 1 (default): crops the video or background image to fit the pane.	1
UserInfos	array<object>	The information about the user whose stream is mixed. If an empty value is returned, streams from all users are mixed.
	object
ChannelId	string	The ID of the channel where the user is.	yourChannelId
UserId	string	The ID of the user.	yourSubUserId
SourceType	string	The source of the video. This parameter is valid only if you set StreamType to 2. Valid values: camera (default): captures the video by using a camera. shareScreen: captures the content displayed on a screen.	camera
StreamType	string	The type of the stream that is relayed. Valid values: 0 (default): the original stream. 1: the audio-only stream. 2: the video-only stream.	0
SeiParams	object	The SEI configuration parameters.
LayoutVolume	object	The layout and volume SEI. If the return value is an empty string, the default layout and volume SEI is used.
FollowIdr	string	Indicates whether to add SEI messages to Instantaneous Decoder Refresh (IDR) frames. Valid values: 0: does not add SEI messages. 1: adds SEI messages.	0
Interval	string	The interval at which the SEI messages are added. Unit: milliseconds.	1000
PassThrough	object	The custom SEI.
FollowIdr	string	Indicates whether to add SEI messages to Instantaneous Decoder Refresh (IDR) frames. Valid values: 0: does not add SEI messages. 1: adds SEI messages.	0
Interval	string	The interval at which the SEI messages are added. Unit: milliseconds.	1000
PayloadContent	string	The payload content of the custom SEI.	yourPayloadContent
PayloadContentKey	string	The key of the payload content. Default value: udd.	yourPayloadContentKey
PayloadType	string	The custom payload type. Valid values: 100 to 254. Default value: 5.	100

Examples

Success response

JSON format

{
  "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"
      }
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam	%s.	Parameter verification failed
400	InvalidAppId	%s, please check and try again later.	AppId is invalid, please check and try again.
400	MissingParam	%s, please check and try again later.	Parameter is missing, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
403	OperationDenied	Your account has not enabled the Live service
403	Forbidden	%s, please check and try again later.	No permission, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.