DescribeLiveStreamPreloadTasks - 查询直播预热任务

仅支持查询最近3天内的数据。

接口说明

使用说明

调用本接口仅支持查询最近 3 天内的数据。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:DescribeLiveStreamPreloadTasks
  • Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

名称类型必填描述示例值
DomainNamestring

播流域名。

example.com
TaskIdstring

任务 ID。您可以通过调用 SetLiveStreamPreloadTasks 接口获取预热任务 ID。

yourTaskId
PlayUrlstring

直播 URL,支持批量设置多个直播 URL,多个 URL 之间用逗号(,)分隔,不超过 100 个。

rtmp://guide.aliyundoc.com/liveApp****/liveStream****
PageSizeinteger

每页大小,最大 100,取值:1~100 之间的任意整数。

10
PageNuminteger

取得第几页,默认 1。

1
Statusstring

任务状态。取值:

  • complete:已完成。
  • pending:等待预热。
  • preloading:预热中。
  • failed:预热失败。
complete
StartTimestring

起始时间,UTC 格式,例如:2016-06-29T19:00:00Z,开始时间必须在近 3 天内。

2016-06-29T19:00:00Z
EndTimestring

结束时间,UTC 格式,例如:2016-06-30T19:00:00Z,EndTime 和 StartTime 之间的间隔不能超过 3 天。

2016-06-30T19:00:00Z

返回参数

名称类型描述示例值
object
PageNuminteger

分页的页码。

1
PageSizeinteger

每页大小。

2
PreloadTasksarray<object>

直播预热详情。

PreloadTaskobject

直播预热详情。

Areastring

预热区域。取值:

  • domestic:中国内地。
  • overseas:海外及港澳台加速。
  • global:全球加速。
说明 如果不传该参数,默认的预热区域为您的域名所配置的加速区域。
domestic
CreateTimestring

预热任务创建时间。

2016-06-29T19:00:00Z
Descriptionstring

预热任务是否成功。取值:

  • Successfully:成功。
  • InternalError:失败。
Successfully
DomainNamestring

播流域名。

example.com
PlayUrlstring

直播 URL。

rtmp://guide.aliyundoc.com/liveApp****/liveStream****
PreloadedEndTimestring

预热结束时间。

2016-06-30T19:00:00Z
PreloadedStartTimestring

预热开始时间。

2016-06-29T19:00:00Z
Processstring

进度百分比。

100%
Statusstring

任务状态。取值:

  • Success:成功。
  • Failed:失败。
说明 只要有一条任务创建失败即为失败
Success
TaskIdstring

任务 ID。

yourTaskId
RequestIdstring

请求 ID。

E1564CBC-DCFE-5E1B-8B78-8DED9A39F334
TotalNuminteger

符合条件的总个数。

1
TotalPageinteger

总页数。

1

示例

正常返回示例

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错误码错误信息描述
400InvalidParamParameter invalid.输入参数不合法
400InvalidEndTime.MismatchSpecified end time does not match the specified start time.-
400Duration.ExceedDuration between StartTime and EndTime is too long.-
500InternalErrorThe request processing has failed due to backend service exception.-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史