GetSnapshotJob-Intelligent Media Services(IMS)-阿里云帮助中心

Queries the details of a snapshot job.

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:GetSnapshotJob

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	Yes	The ID of the snapshot job.	**d80e4e4044975745c14b**

Response elements

Element	Type	Description	Example
	object	PlainResponse
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
SnapshotJob	object	The snapshot job information.
JobId	string	The job ID.	**d80e4e4044975745c14b**
TriggerSource	string	The trigger source of the request. Valid values: Console : console. Workflow : workflow. API : API	API
Name	string	The job name.	Test job
Type	string	The snapshot type. Valid values: WebVtt : WebVTT snapshot. Sprite : sprite snapshot. Normal : normal static snapshot.	Sprite
Input	object	The job input.
Type	string	The input type. Valid values: OSS: the URL of an OSS object. Media: the media asset ID.	OSS
Media	string	The input media. If Type is set to OSS, enter the OSS object URL. If Type is set to Media, enter the media asset ID. The OSS object URL must be in one of the following formats: oss://bucket/object http(s)://bucket.oss-[RegionId].aliyuncs.com/object In the URLs, bucket is the name of the OSS bucket that resides in the same region as the current project, and object is the file path.	oss://test-bucket/object.mp4
OssFile	object	The OSS triplet.
Bucket	string	OSS Bucket	test-bucket
Location	string	OSS Location	oss-cn-shanghai
Object	string	OSS Object	object.mp4
Output	object	The job output.
Type	string	The output type. Valid values: OSS: the URL of an OSS object. Media: the media asset ID.	OSS
Media	string	The output media. If Type is set to OSS, enter the OSS object URL. If Type is set to Media, enter the media asset ID. The OSS object URL must be in one of the following formats: oss://bucket/object http(s)://bucket.oss-[RegionId].aliyuncs.com/object In the URLs, bucket is the name of the OSS bucket that resides in the same region as the current project, and object is the file path. When capturing multiple static snapshots, the object must contain the "{Count}" placeholder. When capturing sprite snapshots, the object must contain the "{TileCount}" placeholder. For WebVTT snapshots, the object extension must be ".vtt".	http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg
OssFile	object	The OSS triplet.
Bucket	string	OSS Bucket	test-bucket
Location	string	OSS Location	oss-cn-shanghai
Object	string	OSS Object	output-{Count}.jpg
Count	integer	The number of snapshots.	8
Async	boolean	Specifies whether to capture snapshots asynchronously. Default value: true.	true
TemplateId	string	The template ID.	**d80e4e4044975745c14b**
TemplateConfig	string	The snapshot template configuration.	{"Type":"Normal","FrameType":"normal","Time":0,"Count":10}
PipelineId	string	The pipeline ID.	**d80e4e4044975745c14b**
Status	string	The job status. Valid values: Init : submitted. Success : success. Fail : failed.	Success
Code	string	The error code.	ResourceNotFound
Message	string	The error message.	The specified resource for "Pipeline" could not be found.
SubmitTime	string	The time when the job was submitted. The time follows the ISO 8601 standard in UTC (ending with Z).	2022-07-12T16:17:54Z
FinishTime	string	The time when the job was completed. The time follows the ISO 8601 standard in UTC (ending with Z).	2022-07-12T16:30:54Z
UserData	string	The custom user data.	{"test parameter": "test value"}
CreateTime	string	The creation time. The time follows the ISO 8601 standard in UTC (ending with Z).	2022-07-12T16:17:54Z
ModifiedTime	string	The last modification time. The time follows the ISO 8601 standard in UTC (ending with Z).	2022-07-12T16:30:54Z

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "SnapshotJob": {
    "JobId": "****d80e4e4044975745c14b****",
    "TriggerSource": "API",
    "Name": "Test job",
    "Type": "Sprite",
    "Input": {
      "Type": "OSS",
      "Media": "oss://test-bucket/object.mp4",
      "OssFile": {
        "Bucket": "test-bucket",
        "Location": "oss-cn-shanghai",
        "Object": "object.mp4"
      }
    },
    "Output": {
      "Type": "OSS",
      "Media": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg",
      "OssFile": {
        "Bucket": "test-bucket",
        "Location": "oss-cn-shanghai",
        "Object": "output-{Count}.jpg"
      }
    },
    "Count": 8,
    "Async": true,
    "TemplateId": "****d80e4e4044975745c14b****",
    "TemplateConfig": "{\"Type\":\"Normal\",\"FrameType\":\"normal\",\"Time\":0,\"Count\":10}",
    "PipelineId": "****d80e4e4044975745c14b****",
    "Status": "Success",
    "Code": "ResourceNotFound",
    "Message": "The specified resource for \"Pipeline\" could not be found.",
    "SubmitTime": "2022-07-12T16:17:54Z",
    "FinishTime": "2022-07-12T16:30:54Z",
    "UserData": "{\"test parameter\": \"test value\"}",
    "CreateTime": "2022-07-12T16:17:54Z",
    "ModifiedTime": "2022-07-12T16:30:54Z"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.