调用DescribeMixStreamList查询合流任务列表。
使用说明
先通过CreateMixStream接口创建合流任务,再调用本接口查询合流任务列表。
QPS限制
本接口的单用户QPS限制为5次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | DescribeMixStreamList | 系统规定参数。取值:DescribeMixStreamList。 |
DomainName | String | 否 | example.com | 主播流域名。 |
AppName | String | 否 | liveApp**** | App名称。 |
StreamName | String | 否 | liveStream**** | 合流任务的流名。 |
MixStreamId | String | 否 | 5b2a046e-74d7-385e-d2d7-8a5b87e4**** | 合流任务ID。如果您通过CreateMixStream接口创建合流任务,请查看CreateMixStream接口调用返回的参数MixStreamId值。 |
StartTime | String | 否 | 2020-09-11T12:00:00Z | 开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
EndTime | String | 否 | 2020-09-20T13:00:00Z | 结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
PageNo | Integer | 否 | 1 | 页码。大于0且不超过Integer数据类型的最大值,默认值为1。 |
PageSize | Integer | 否 | 1000 | 每页可展示的记录数。默认值为1000。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
MixStreamList | Array of MixStreamInfo | 合流任务列表。 |
|
AppName | String | liveApp**** | App名称。 |
DomainName | String | example.com | 主播流域名。 |
GmtCreate | String | 2020-09-17T08:39:14Z | 合流任务创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
GmtModified | String | 2020-09-17T08:39:15Z | 合流任务修改时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
InputStreamNumber | Integer | 2 | 输入源个数。 |
LayoutId | String | USERDEFINED | 布局ID。 |
MixStreamTemplate | String | lp_ld | 合流输出模板。 |
MixstreamId | String | aaf9a50f-c460-3a9b-f180-38dd8f05**** | 合流任务ID。可作为删除合流任务的请求参数。 |
StreamName | String | liveStream**** | 合流任务的流名。 |
RequestId | String | BC1E78D3-FA8B-4457-DEE2-6093E1232254 | 请求ID。 |
Total | Integer | 1 | 任务总数。 |
MixStreamInfo
名称 |
类型 |
描述 |
MixStreamId |
String |
合流任务ID。 |
DomainName |
String |
主播流域名。 |
AppName |
String |
App名称。 |
StreamName |
String |
合流任务的流名。 |
LayoutId |
String |
布局ID。 |
InputStreamNumber |
Integer |
输入源个数。 |
MixStreamTemplate |
String |
合流任务模板。 |
GmtCreate |
String |
创建时间,格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
GmtModified |
String |
修改时间,格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
示例
请求示例
http(s)://live.aliyuncs.com/?Action=DescribeMixStreamList
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeMixStreamListResponse>
<MixStreamList>
<AppName>liveApp****</AppName>
<DomainName>example.com</DomainName>
<GmtCreate>2020-09-17T08:39:14Z</GmtCreate>
<GmtModified>2020-09-17T08:39:15Z</GmtModified>
<InputStreamNumber>2</InputStreamNumber>
<LayoutId>USERDEFINED</LayoutId>
<MixStreamTemplate>lp_ld</MixStreamTemplate>
<MixstreamId>aaf9a50f-c460-3a9b-f180-38dd8f05****</MixstreamId>
<StreamName>liveStream****</StreamName>
</MixStreamList>
<RequestId>BC1E78D3-FA8B-4457-DEE2-6093E1232254</RequestId>
<Total>1</Total>
</DescribeMixStreamListResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"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
}
错误码
访问错误中心查看更多错误码。
SDK示例
详细示例,请参见合流代码示例。