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

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

接口说明

使用说明

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

QPS 限制

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vod:GetMediaRefreshJobs	list	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
MediaRefreshJobId	string	是	音/视频刷新或预热的任务 ID，为提交音视频刷新或预热任务接口返回参数 MediaRefreshJobId 的值。	41d465e31957****
MediaId	string	否	音/视频 ID，为提交音视频刷新或预热任务时传入的`MediaIds`，只能设置一个音/视频 ID。若不传入本参数，则查询`MediaRefreshJobId`下所有音/视频的任务信息；若传入本参数，则只查询`MediaRefreshJobId`下该音/视频 ID 所对应的任务信息。	ca3a8f6e4957b658067095869****

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	25818875-5F78-4AF6-D7393642CA58****
MediaRefreshJobs	array<object>	音/视频刷新或预热任务信息列表。
MediaRefreshJob	object	音/视频刷新或预热任务详情。
MediaRefreshJobId	string	音/视频刷新或预热的任务 ID。	41d465e31957****
MediaId	string	音/视频 ID。	ca3a8f6e4957b658067095869****
TaskType	string	任务类型。取值： Refresh：刷新 Preload：预热	Preload
FilterPolicy	string	播放流的筛选策略。JSON 格式，内容为提交音视频刷新或预热任务接口的请求参数。	{"Formats":"mp4,m3u8", "Definitions":"HD,SD", " StreamType":"video", "ResultType":"Single", " SliceFlag":false, "SliceCount": 3}
Status	string	任务状态。取值： success：成功 fail：失败	success
SuccessPlayUrls	string	成功被刷新或预热的播放 URL。	https://shenzhen.**.aliyuncdn.com/74401a4f546007bf845cd8840.m3u8,https://shenzhen..aliyuncdn.com/24041e7d13582d86604d8**.m3u8
TaskIds	string	播放 URL 的刷新或预热的任务 ID，一个 URL 对应一个任务 ID。该任务 ID 用于 DescribeVodRefreshTasks 接口查询每个播放 URL 的刷新或预热状态。	70422**,9524**
ErrorCode	string	错误码。当提交刷新或预热任务失败时会有该字段。	PreloadQueueFull
ErrorMessage	string	错误信息。当提交刷新或预热任务失败时会有该字段。	Preload queue is full, please try again later!
UserData	string	提交刷新或预热任务时传入的 UserData 信息。	{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}}
GmtCreate	string	任务创建时间。	2022-05-20 08:23:22
GmtModified	string	任务修改时间。	2022-05-21 08:23:22

示例

正常返回示例

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-20 08:23:22",
      "GmtModified": "2022-05-21 08:23:22"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2022-03-31	新增 OpenAPI	查看变更详情