DescribeMixStreamList - - Alibaba Cloud Documentation Center

Operation description

Call the CreateMixStream operation to create a stream mixing task. You can then call this operation to query the list of stream mixing tasks.

QPS limit

The queries per second (QPS) limit for this operation is 5 for each user. API calls that exceed this limit are throttled. This can affect your business. Plan your API calls accordingly.

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:DescribeMixStreamList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	No	The streaming domain.	example.com
AppName	string	No	The app name.	liveApp****
StreamName	string	No	The stream name of the stream mixing task.	liveStream****
MixStreamId	string	No	The ID of the stream mixing task. If you create a stream mixing task by calling the CreateMixStream operation, use the MixStreamId value that is returned in the response.	5b2a046e-74d7-385e-d2d7-8a5b87e4****
StartTime	string	No	The start time. The time is in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.	2020-09-11T12:00:00Z
EndTime	string	No	The end time. The time is in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.	2020-09-20T13:00:00Z
PageNo	integer	No	The page number. The value must be greater than 0 and cannot exceed the maximum value of the Integer data type. Default value: 1.	1
PageSize	integer	No	The number of records to display on each page. Default value: 1000.	1000

Response parameters

Parameter	Type	Description	Example
	object
MixStreamList	array<object>	The list of stream mixing tasks.
	object	The list of stream mixing tasks.
AppName	string	The app name.	liveApp****
DomainName	string	The streaming domain.	example.com
GmtCreate	string	The time when the stream mixing task was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.	2020-09-17T08:39:14Z
GmtModified	string	The time when the stream mixing task was last modified. The time is in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.	2020-09-17T08:39:15Z
InputStreamNumber	integer	The number of input sources.	2
LayoutId	string	The layout ID.	USERDEFINED
MixStreamTemplate	string	The stream mixing template.	lp_ld
MixstreamId	string	The ID of the stream mixing task. You can use this ID to delete the task.	aaf9a50f-c460-3a9b-f180-38dd8f05****
StreamName	string	The stream name of the stream mixing task.	liveStream****
RequestId	string	The request ID.	BC1E78D3-FA8B-4457-DEE2-6093E1232254
Total	integer	The total number of tasks.	1

MixStreamInfo

Name	Type	Description
MixStreamId	String	The ID of the stream mixing task.
DomainName	String	The streaming domain.
AppName	String	The app name.
StreamName	String	The stream name of the stream mixing task.
LayoutId	String	The layout ID.
InputStreamNumber	Integer	The number of input sources.
MixStreamTemplate	String	The stream mixing template.
GmtCreate	String	The time when the task was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.
GmtModified	String	The time when the task was last modified. The time is in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.

Examples

Success response

JSON format

{
  "MixStreamList": [
    {
      "AppName": "liveApp****",
      "DomainName": "example.com",
      "GmtCreate": "2020-09-17T08:39:14Z",
      "GmtModified": "2020-09-17T08:39:15Z",
      "InputStreamNumber": 2,
      "LayoutId": "USERDEFINED",
      "MixStreamTemplate": "lp_ld",
      "MixstreamId": "aaf9a50f-c460-3a9b-f180-38dd8f05****",
      "StreamName": "liveStream****"
    }
  ],
  "RequestId": "BC1E78D3-FA8B-4457-DEE2-6093E1232254",
  "Total": 1
}

Error codes

HTTP status code	Error code	Error message
400	InvalidUserId.Malformed	%s
400	InvalidParameter.Malformed	%s
400	MissingParameter	%s
401	IllegalOperation	%s
500	InternalError	%s
404	InvalidDomainName.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.