Use ListSnapshotJobs to query a list of snapshot jobs - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Queries a list of snapshot jobs.

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

ice:ListSnapshotJobs

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartOfCreateTime	string	No	The beginning of the time range during which the jobs to be queried were created.	2022-07-12T00:00:00Z
EndOfCreateTime	string	No	The end of the time range during which the jobs to be queried were created.	2022-07-14T00:00:00Z
Status	string	No	The state of the job. Valid values: Init: The job is submitted. Success: The job is successful. Fail: The job failed. Valid values: Init : Success : Fail :	Success
OrderBy	string	No	The order that you use to sort the query results. CreateTimeDesc CreateTimeAsc Valid values: CreateTimeDesc: sorts the jobs by creation time in descending order CreateTimeAsc: sorts the jobs by creation time in ascending order. Valid values: CreateTimeDesc : CreateTimeAsc :	CreateTimeDesc
JobId	string	No	The job ID.	**20b48fb04483915d4f2cd8ac**
PageSize	integer	No	The number of entries per page. Default value: 20. Maximum value: 100.	20
NextPageToken	string	No	The pagination token that is used in the next request to retrieve a new page of results.	**20b48fb04483915d4f2cd8ac**

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
Jobs	array<object>	The list of jobs.
	array<object>	The information about the snapshot job.
JobId	string	The job ID.	**20b48fb04483915d4f2cd8ac**
TriggerSource	string	The request trigger source. Valid values: Console Workflow API Valid values: Console : Workflow : API : API	API
Name	string	The name of the job.	SampleJob
Type	string	The type of the job. Valid values: WebVtt Sprite Normal Valid values: WebVtt : Sprite : Normal :	Sprite
Input	object	The input of the job.
Type	string	The type of the input file. Valid values: OSS: an Object Storage Service (OSS) object. Media: a media asset.	OSS
Media	string	The input file. If Type is set to OSS, the URL of an OSS object is returned. If Type is set to Media, the ID of a media asset is returned. The URL of an OSS object can be in one of the following formats: 1. OSS://bucket/object 2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object In the URL, bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object URL in OSS.	oss://bucket/object.mp4
Output	object	The output of the job.
Type	string	The type of the output file. Valid values: OSS: an OSS object. Media: a media asset.	OSS
Media	string	The output file. If Type is set to OSS, the URL of an OSS object is returned. If Type is set to Media, the ID of a media asset is returned. The URL of an OSS object can be in one of the following formats: OSS://bucket/object http(s)://bucket.oss-[RegionId].aliyuncs.com/object In the URL, bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object URL in OSS. If multiple static snapshots were captured, the object must contain the "{Count}" placeholder. In the case of a sprite, the object must contain the "{TileCount}" placeholder. The suffix of the WebVTT snapshot objects must be ".vtt".	http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg
Count	integer	The number of snapshots.	10
Async	boolean	Indicates whether the snapshots were captured in asynchronous mode.	true
TemplateId	string	The template ID.	**20b48fb04483915d4f2cd8ac**
PipelineId	string	The ID of the MPS queue to which the job was submitted.	**20b48fb04483915d4f2cd8ac**
Status	string	The state of the job. Success: The job is successful. Fail: The job failed. Init: The job is submitted. Valid values: Init : Success : Fail :	Success
SubmitTime	string	The time when the job was submitted.	2022-07-12T16:17:54Z
FinishTime	string	The time when the job was complete.	2022-07-12T16:30:54Z
CreateTime	string	The time when the job was created.	2022-07-12T16:17:54Z
ModifiedTime	string	The time when the job was last modified.	2022-07-12T16:30:54Z
NextPageToken	string	The pagination token that is used in the next request to retrieve a new page of results.	**20b48fb04483915d4f2cd8ac**

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Jobs": [
    {
      "JobId": "****20b48fb04483915d4f2cd8ac****",
      "TriggerSource": "API",
      "Name": "SampleJob",
      "Type": "Sprite",
      "Input": {
        "Type": "OSS",
        "Media": "oss://bucket/object.mp4"
      },
      "Output": {
        "Type": "OSS",
        "Media": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg"
      },
      "Count": 10,
      "Async": true,
      "TemplateId": "****20b48fb04483915d4f2cd8ac****",
      "PipelineId": "****20b48fb04483915d4f2cd8ac****",
      "Status": "Success",
      "SubmitTime": "2022-07-12T16:17:54Z",
      "FinishTime": "2022-07-12T16:30:54Z",
      "CreateTime": "2022-07-12T16:17:54Z",
      "ModifiedTime": "2022-07-12T16:30:54Z"
    }
  ],
  "NextPageToken": "****20b48fb04483915d4f2cd8ac****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.