查询合流任务列表。
接口说明
先通过 CreateMixStream 接口创建合流任务,再调用本接口查询合流任务列表。
QPS 限制
本接口的单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
live:DescribeMixStreamList | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DomainName | string | 否 | 主播流域名。 | example.com |
AppName | string | 否 | App 名称。 | liveApp**** |
StreamName | string | 否 | 合流任务的流名。 | liveStream**** |
MixStreamId | string | 否 | 合流任务 ID。如果您通过 CreateMixStream 接口创建合流任务,请查看 CreateMixStream 接口调用返回的参数 MixStreamId 值。 | 5b2a046e-74d7-385e-d2d7-8a5b87e4**** |
StartTime | string | 否 | 开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 | 2020-09-11T12:00:00Z |
EndTime | string | 否 | 结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 | 2020-09-20T13:00:00Z |
PageNo | integer | 否 | 页码。大于 0 且不超过 Integer 数据类型的最大值,默认值为 1。 | 1 |
PageSize | integer | 否 | 每页可展示的记录数。默认值为 1000。 | 1000 |
返回参数
示例
正常返回示例
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
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | InvalidUserId.Malformed | %s |
400 | InvalidParameter.Malformed | %s |
400 | MissingParameter | %s |
401 | IllegalOperation | %s |
404 | InvalidDomainName.NotFound | %s |
500 | InternalError | %s |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史
SDK 示例
详细示例,请参见合流代码示例。