首页 视频点播 API参考指南 API目录 点播CDN 刷新预热 GetMediaRefreshJobs - 查询视频刷新或预热任务信息

GetMediaRefreshJobs - 查询视频刷新或预热任务信息

调用GetMediaRefreshJobs查询视频刷新或预热任务的任务状态、筛选策略等任务信息。

接口说明

使用说明

支持查询刷新或预热任务下所有音/视频的任务信息或指定查某一个音/视频的任务信息。

QPS限制

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

调试

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

调试

授权信息

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

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

请求参数

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

音/视频刷新或预热的任务ID,为提交音视频刷新或预热任务接口返回参数MediaRefreshJobId的值。

41d465e31957****
MediaIdstring

音/视频ID,为提交音视频刷新或预热任务时传入的MediaIds,只能设置一个音/视频ID。

若不传入本参数,则查询MediaRefreshJobId下所有音/视频的任务信息;若传入本参数,则只查询MediaRefreshJobId下该音/视频ID所对应的任务信息。

ca3a8f6e4957b658067095869****

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求ID。

25818875-5F78-4AF6-D7393642CA58****
MediaRefreshJobsarray

音/视频刷新或预热任务信息列表。

object

音/视频刷新或预热任务详情。

MediaRefreshJobIdstring

音/视频刷新或预热的任务ID。

41d465e31957****
MediaIdstring

音/视频ID。

ca3a8f6e4957b658067095869****
TaskTypestring

任务类型。取值:

  • Refresh:刷新
  • Preload:预热
Preload
FilterPolicystring

播放流的筛选策略。JSON格式,内容为提交音视频刷新或预热任务接口的请求参数。

{"Formats":"mp4,m3u8", "Definitions":"HD,SD", " StreamType":"video", "ResultType":"Single", " SliceFlag":false, "SliceCount": 3}
Statusstring

任务状态。取值:

  • success:成功
  • fail:失败
success
SuccessPlayUrlsstring

成功被刷新或预热的播放URL。

https://shenzhen.****.aliyuncdn.com/74401a4f546007bf845cd8840****.m3u8,https://shenzhen.****.aliyuncdn.com/24041e7d13582d86604d8****.m3u8
TaskIdsstring

播放URL的刷新或预热的任务ID,一个URL对应一个任务ID。该任务ID用于DescribeVodRefreshTasks接口查询每个播放URL的刷新或预热状态。

70422****,9524****
ErrorCodestring

错误码。 当提交刷新或预热任务失败时会有该字段。

PreloadQueueFull
ErrorMessagestring

错误信息。 当提交刷新或预热任务失败时会有该字段。

Preload queue is full, please try again later!
UserDatastring

提交刷新或预热任务时传入的UserData信息。

{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}}
GmtCreatestring

任务创建时间。

2022-05-20T08:23:22Z
GmtModifiedstring

任务修改时间。

2022-05-21T08:23:22Z

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "MediaRefreshJobs": [
    {
      "MediaRefreshJobId": "41d465e31957****",
      "MediaId": "ca3a8f6e4957b658067095869****",
      "TaskType": "Preload",
      "FilterPolicy": "{\"Formats\":\"mp4,m3u8\", \"Definitions\":\"HD,SD\",  \" StreamType\":\"video\",  \"ResultType\":\"Single\",  \" SliceFlag\":false, \"SliceCount\": 3}",
      "Status": "success",
      "SuccessPlayUrls": "https://shenzhen.****.aliyuncdn.com/74401a4f546007bf845cd8840****.m3u8,https://shenzhen.****.aliyuncdn.com/24041e7d13582d86604d8****.m3u8",
      "TaskIds": "70422****,9524****",
      "ErrorCode": "PreloadQueueFull",
      "ErrorMessage": "Preload queue is full, please try again later!",
      "UserData": "{\"MessageCallback\":{\"CallbackURL\":\"http://example.aliyundoc.com\"}, \"Extend\":{\"localId\":\"xxx\",\"test\":\"www\"}}",
      "GmtCreate": "2022-05-20T08:23:22Z",
      "GmtModified": "2022-05-21T08:23:22Z"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-03-31新增 OpenAPI
阿里云首页 视频点播 相关技术圈