Call GetMediaRefreshJobs to query media refresh and prefetch jobs - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries task information such as task status and filtering policies for a video purge or prefetch task.

Operation description

Usage notes

You can query task information for all audio or video files under a purge or prefetch task, or query task information for a specific audio or video file.

QPS limit

The single-user QPS limit for this operation is 50 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation as needed. For more information, see QPS limit.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:GetMediaRefreshJobs

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaRefreshJobId	string	Yes	The ID of the audio or video purge or prefetch task. This is the value of MediaRefreshJobId returned by the SubmitMediaRefreshJob operation.	41d465e31957****
MediaId	string	No	The audio or video ID, which is the `MediaIds` value specified when calling the SubmitMediaRefreshJob operation. Only one audio or video ID can be specified. If this parameter is not specified, task information for all audio or video files under the specified `MediaRefreshJobId` is returned. If this parameter is specified, only the task information for the specified audio or video ID under the `MediaRefreshJobId` is returned.	ca3a8f6e4957b658067095869****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	25818875-5F78-4AF6-D7393642CA58****
MediaRefreshJobs	array<object>	The list of audio or video purge or prefetch task information.
	object	The details of the audio or video purge or prefetch task.
MediaRefreshJobId	string	The ID of the audio or video purge or prefetch task.	41d465e31957****
MediaId	string	The audio or video ID.	ca3a8f6e4957b658067095869****
TaskType	string	The task type. Valid values: Refresh: purge Preload: prefetch	Preload
FilterPolicy	string	The filtering policy for playback streams. The value is in JSON format and contains the request parameters of the SubmitMediaRefreshJob operation.	{"Formats":"mp4,m3u8", "Definitions":"HD,SD", " StreamType":"video", "ResultType":"Single", " SliceFlag":false, "SliceCount": 3}
Status	string	The task status. Valid values: success: succeeded fail: failed	success
SuccessPlayUrls	string	The playback URLs that were successfully purged or prefetched.	https://shenzhen.**.aliyuncdn.com/74401a4f546007bf845cd8840.m3u8,https://shenzhen..aliyuncdn.com/24041e7d13582d86604d8**.m3u8
TaskIds	string	The task IDs for the purge or prefetch of playback URLs. Each URL corresponds to one task ID. You can use the task ID to call the DescribeVodRefreshTasks operation to query the purge or prefetch status of each playback URL.	70422**,9524**
ErrorCode	string	The error code. This field is returned when the purge or prefetch task fails to be submitted.	PreloadQueueFull
ErrorMessage	string	The error message. This field is returned when the purge or prefetch task fails to be submitted.	Preload queue is full, please try again later!
UserData	string	The UserData information specified when the purge or prefetch task was submitted.	{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}}
GmtCreate	string	The time when the task was created.	2022-05-20 08:23:22
GmtModified	string	The time when the task was last modified.	2022-05-21 08:23:22

Examples

Success response

JSON format

{
  "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"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.