SubmitDynamicImageJob - Intelligent Media Services - Alibaba Cloud Documentation Center

Submits an image animation job.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ice:SubmitDynamicImageJob		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the job.	SampleJob
Input	object	Yes	The input of the job.
Type	string	Yes	The type of the input file. Valid values: OSS: an Object Storage Service (OSS) object. Media: a media asset.	OSS
Media	string	Yes	The input file. If Type is set to OSS, set this parameter to the URL of an OSS object. If Type is set to Media, set this parameter to the ID of a media asset. 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. Note Before you use the OSS bucket in the URL, you must add the bucket on the Storage Management page of the Intelligent Media Services (IMS) console.	oss://bucket/object.mp4
Output	object	Yes	The output of the job.
Type	string	Yes	The type of the output file. Valid values: OSS: an OSS object. Media: a media asset.	Media
Media	string	Yes	The output file. The file can be an OSS object or a media asset. 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. Note Before you use the OSS bucket in the URL, you must add the bucket on the Storage Management page of the IMS console.	**96e8864746a0b6f3**
TemplateConfig	object	Yes	The snapshot template configuration.
TemplateId	string	Yes	The template ID.	**96e8864746a0b6f3**
OverwriteParams	object	No	The parameters that are used to overwrite the corresponding parameters.
Format	string	No	The format of the animated image. Valid values: gif webp	gif
Width	integer	No	The width of the animated image. Valid values: [128,4096].	1024
Height	integer	No	The height of the animated image. Valid values: [128,4096].	720
Fps	integer	No	The frame rate. Valid values: [1,60].	15
ScanMode	string	No	The scan mode. Valid values: interlaced progressive This is the default value.	progressive
LongShortMode	boolean	No	Specifies whether to enable the auto-rotate screen feature. Valid values: true false Default value: true. Note If this feature is enabled, the width of the output video corresponds to the long side of the input video, which is the height of the input video in portrait mode. The height of the output video corresponds to the short side of the input video, which is the width of the input video in portrait mode.	false
TimeSpan	object	No	The timeline parameters.
Seek	string	No	The start point of the clip. Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`. Valid values: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`.	01:59:59.999 or 32000.23
Duration	string	No	The length of the clip. Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`. Valid values: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`.	01:59:59.999 or 32000.23
End	string	No	The length of the ending part of the original clip to be cropped out. If you specify this parameter, the Duration parameter becomes invalid. Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`. Valid values: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`.	01:59:59.999 or 32000.23
ScheduleConfig	object	No	The scheduling settings.
PipelineId	string	No	The ID of the MPS queue to which the job was submitted.	**96e8864746a0b6f3**
Priority	integer	No	The priority. Valid values: 1 to 10. Default value: 6. A greater value specifies a higher priority.	6
UserData	string	No	The user-defined data.	{"SampleKey": "SampleValue"}

Response parameters

Parameter	Type	Description	Example
	object	PlainResponse
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
JobId	string	The job ID.	**20b48fb04483915d4f2cd8ac**

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobId": "****20b48fb04483915d4f2cd8ac****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-08-10	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-07-11	Add Operation	View Change Details