Queries the parameters of mixed-stream relay tasks.
Operation description
- You can call the ListRtcMPUTaskDetail operation to query the parameters of mixed-stream relay tasks that were created by calling the StartLiveMPUTask operation.
- By default, the query results are sorted in reverse chronological order based on the task update time.
QPS limit
You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
live:ListRtcMPUTaskDetail | list | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
AppId | string | Yes | The ID of the application. Note
The ID can be up to 64 characters in length and can contain letters, digits, underscores (_), and hyphens (-).
| yourAppId |
TaskId | string | No | The task ID. Note
| yourTaskId |
PageSize | long | No | The number of entries per page. Valid values: 1 to 100. Note
If you do not specify TaskId, you must specify PageSize and PageNo. Then, the parameters of all stream relay tasks for the specified application are returned in pages.
| 10 |
PageNo | long | No | The page number. | 20 |
Response parameters
Examples
Sample success responses
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 |
---|---|---|
400 | InvalidParam | %s |
400 | InvalidAppId | %s |
403 | OperationDenied | Your account has not enabled the Live service |
403 | Forbidden | %s |
404 | MissingParam | %s |
500 | InternalError | InternalError |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-11-14 | The Error code has changed. The response structure of the API has changed | View Change Details |
2024-10-30 | The Error code has changed. The response structure of the API has changed | View Change Details |
2024-08-13 | The Error code has changed. The response structure of the API has changed | View Change Details |
2024-08-06 | The Error code has changed. The response structure of the API has changed | View Change Details |
2024-07-04 | The Error code has changed | View Change Details |