仅支持查询最近3天内的数据。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| live:DescribeLiveStreamPreloadTasks |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DomainName | string | 是 | 播流域名。 | example.com |
| TaskId | string | 否 | 任务 ID。您可以通过调用 SetLiveStreamPreloadTasks 接口获取预热任务 ID。 | yourTaskId |
| PlayUrl | string | 否 | 直播 URL，支持批量设置多个直播 URL，多个 URL 之间用逗号（,）分隔，不超过 100 个。 | rtmp://guide.aliyundoc.com/liveApp****/liveStream**** |
| PageSize | integer | 否 | 每页大小，最大 100，取值：1~100 之间的任意整数。 | 10 |
| PageNum | integer | 否 | 取得第几页，默认 1。 | 1 |
| Status | string | 否 | 任务状态。取值：
| complete |
| StartTime | string | 否 | 起始时间，UTC 格式，例如：2016-06-29T19:00:00Z，开始时间必须在近 3 天内。 | 2016-06-29T19:00:00Z |
| EndTime | string | 否 | 结束时间，UTC 格式，例如：2016-06-30T19:00:00Z，EndTime 和 StartTime 之间的间隔不能超过 3 天。 | 2016-06-30T19:00:00Z |
返回参数
示例
正常返回示例
JSON格式
{
"PageNum": 1,
"PageSize": 2,
"PreloadTasks": {
"PreloadTask": [
{
"Area": "domestic",
"CreateTime": "2016-06-29T19:00:00Z",
"Description": "Successfully",
"DomainName": "example.com",
"PlayUrl": "rtmp://guide.aliyundoc.com/liveApp****/liveStream****",
"PreloadedEndTime": "2016-06-30T19:00:00Z",
"PreloadedStartTime": "2016-06-29T19:00:00Z",
"Process": "100%",
"Status": "Success",
"TaskId": "yourTaskId"
}
]
},
"RequestId": "E1564CBC-DCFE-5E1B-8B78-8DED9A39F334",
"TotalNum": 1,
"TotalPage": 1
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParam | Parameter invalid. | 输入参数不合法 |
| 400 | InvalidEndTime.Mismatch | Specified end time does not match the specified start time. | - |
| 400 | Duration.Exceed | Duration between StartTime and EndTime is too long. | - |
| 500 | InternalError | The request processing has failed due to backend service exception. | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史