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

Queries the details of a dynamic image task.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	No	The ID of the dynamic image task.	**d80e4e4044975745c14b**

Response elements

Element	Type	Description	Example
	object	PlainResponse
RequestId	string	The ID of the request.	****36-3C1E-4417-BDB2-1E034F****
DynamicImageJob	object	The dynamic image task information.
JobId	string	The ID of the task.	**d80e4e4044975745c14b**
TriggerSource	string	The trigger source of the request. Valid values: Console : Console. Workflow : Workflow. API : API	API
Name	string	The name of the task.	SampleJob
Input	object	The input of the task.
Type	string	The input type. Valid values: OSS: the URL of an OSS object. Media: the ID of a media asset. Valid values: Media : The ID of a media asset. OSS : The URL of an OSS object.	OSS
Media	string	The input media. If Type is set to OSS, enter the URL of the OSS object. If Type is set to Media, enter the ID of the media asset. The URL of the OSS object must be in one of the following formats: oss://bucket/object http(s)://bucket.oss-[RegionId].aliyuncs.com/object In the formats, 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/sample-input.mp4
OssFile	object	The OSS triplet.
Bucket	string	OSS Bucket	test-bucket
Location	string	OSS Location	oss-cn-shanghai
Object	string	OSS Object	sample-input.mp4
Output	object	The output of the task.
Type	string	The output type. Valid values: OSS: the URL of an OSS object. Media: the ID of a media asset. Valid values: Media : The ID of a media asset. OSS : The URL of an OSS object.	Media
Media	string	The output media. If Type is set to OSS, enter the URL of the OSS object. If Type is set to Media, enter the ID of the media asset. The URL of the OSS object must be in one of the following formats: oss://bucket/object http(s)://bucket.oss-[RegionId].aliyuncs.com/object In the formats, bucket is the name of the OSS bucket that resides in the same region as the current project, and object is the file path.	**d80e4e4044975745c14b**
OssFile	object	The OSS triplet.
Bucket	string	OSS Bucket	sample-bucket
Location	string	OSS Location	oss-cn-shanghai
Object	string	OSS Object	path/to/object
OutputUrl	string	The URL of the output dynamic image.	http://test-bucket.oss-cn-shanghai.aliyuncs.com/output.gif
TemplateConfig	string	The dynamic image template configuration.	{"Format":"gif","Fps":5,"Height":1080,"Width":1920}
TemplateId	string	The ID of the template.	**d80e4e4044975745c14b**
PipelineId	string	The ID of the pipeline.	**d80e4e4044975745c14b**
Status	string	The status of the task. Valid values: Init : Submitted. Success : Success. Fail : Failed.	Success
Code	string	The error code.	ResourceNotFound
Message	string	The error message.	The specified resource for "CustomTemplate" could not be found.
SubmitTime	string	The time when the task was submitted. The time is in the ISO 8601 format and UTC, ending with Z.	2022-07-12T16:17:54Z
FinishTime	string	The time when the task was completed. The time is in the ISO 8601 format and UTC, ending with Z.	2022-07-12T16:30:54Z
UserData	string	The custom user data.	{"sampleParam": "sampleValue"}
CreateTime	string	The creation time. The time is in the ISO 8601 format and UTC, ending with Z.	2022-07-12T16:17:54Z
ModifiedTime	string	The last modification time. The time is in the ISO 8601 format and UTC, ending with Z.	2022-07-12T16:30:54Z

Examples

Success response

JSON format

{
  "RequestId": "******36-3C1E-4417-BDB2-1E034F******",
  "DynamicImageJob": {
    "JobId": "****d80e4e4044975745c14b****\n",
    "TriggerSource": "API",
    "Name": "SampleJob",
    "Input": {
      "Type": "OSS",
      "Media": "oss://test-bucket/sample-input.mp4",
      "OssFile": {
        "Bucket": "test-bucket",
        "Location": "oss-cn-shanghai",
        "Object": "sample-input.mp4"
      }
    },
    "Output": {
      "Type": "Media",
      "Media": "****d80e4e4044975745c14b****",
      "OssFile": {
        "Bucket": "sample-bucket",
        "Location": "oss-cn-shanghai",
        "Object": "path/to/object"
      }
    },
    "OutputUrl": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/output.gif",
    "TemplateConfig": "{\"Format\":\"gif\",\"Fps\":5,\"Height\":1080,\"Width\":1920}",
    "TemplateId": "****d80e4e4044975745c14b****",
    "PipelineId": "****d80e4e4044975745c14b****",
    "Status": "Success",
    "Code": "ResourceNotFound",
    "Message": "The specified resource for \"CustomTemplate\" could not be found.",
    "SubmitTime": "2022-07-12T16:17:54Z",
    "FinishTime": "2022-07-12T16:30:54Z",
    "UserData": "{\"sampleParam\": \"sampleValue\"}",
    "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.