GetMediaConvertJob-阿里云帮助中心

MediaConvert task details

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

get

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	No	The ID of the media transcoding job.	**d80e4e4044975745c14b**

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	4BAEA8E8-1C16-5CD3-AC50-CCBA81A53402
Job	object	The media transcoding job.
RequestId	string	The ID of the job creation request.	****11-DB8D-4A9A-875B-275798****
ClientToken	string	The idempotency parameter for the job creation request.	780018cb-55ba-466d-8acc-946c0c319a0e
JobId	string	The job ID. This is a 32-character string.	****4579b5e748b99a27f6d6****
Config	object	The job configuration.
Inputs	array	The inputs of the transcoding task.
	MediaConvertInput	The input of the transcoding task.
Outputs	array	The output configurations.
	MediaConvertOutput	The output configuration.
OutputGroups	array	The output group configurations.
	MediaConvertOutputGroup	The output group configuration.
JobName	string	Task Name.	job-1-20241205-102045
PipelineId	string	The pipeline ID.	83500cb2a3b94fabb0956e38d64bd16d
UserData	string	The user data.	{"videoId":"ddd333"}
Code	string	The error code if the job fails.	InvalidParameter.ResourceContentBad
Message	string	The error message detailing the failure.	The resource operated InputFile is bad
State	string	The job state. Valid values: Inited: The job is initialized. Running: The job is in progress. Complete: The job finished successfully. Error: The job failed. Cancelled: The job was cancelled.	Complete
OutputDetails	array	The execution results of the outputs specified in the job configuration.
	MediaConvertOutputDetail	The details of an output.
OutputGroupDetails	array	The execution results of the output groups specified in the job configuration.
	MediaConvertOutputGroupDetail	The details of an output group.
Percent	integer	The completion percentage.	0
CreateTime	string	The time when the job was created, in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2024-12-07T13:01:07Z
FinishTime	string	The time when the job finished, in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2024-12-07T13:01:07Z

Examples

Success response

JSON format

{
  "RequestId": "4BAEA8E8-1C16-5CD3-AC50-CCBA81A53402",
  "Job": {
    "RequestId": "******11-DB8D-4A9A-875B-275798******",
    "ClientToken": "780018cb-55ba-466d-8acc-946c0c319a0e  ",
    "JobId": "******4579b5e748b99a27f6d6******",
    "Config": {
      "Inputs": [
        {
          "Name": "InputVideo",
          "InputFile": {
            "Type": "OSS",
            "Media": "http://bucket.loction.aliyuncs.com/path/to/video.mp4"
          }
        }
      ],
      "Outputs": [
        {
          "OutputFile": {
            "Type": "OSS",
            "Media": "http://bucket.loction.aliyuncs.com/path/to/video.mp4"
          },
          "Priority": 6,
          "OverrideParams": "{}",
          "Features": "{}",
          "TemplateId": "****96e8864746a0b6f3****",
          "Name": "output-video"
        }
      ],
      "OutputGroups": [
        {
          "GroupConfig": {
            "OutputFileBase": {
              "Type": "OSS",
              "Media": "http://bucket.loction.aliyuncs.com/path/to/video.mp4"
            },
            "ManifestName": "manifest",
            "Type": "Hls"
          },
          "Outputs": [
            {
              "Priority": 6,
              "OverrideParams": "{}",
              "Features": "{}",
              "OutputFileName": "720p.mp4",
              "TemplateId": "****96e8864746a0b6f3****\n",
              "Name": "group-output"
            }
          ],
          "Name": "hls-group"
        }
      ],
      "JobName": "job-1-20241205-102045"
    },
    "PipelineId": "83500cb2a3b94fabb0956e38d64bd16d",
    "UserData": "{\"videoId\":\"ddd333\"}",
    "Code": "InvalidParameter.ResourceContentBad",
    "Message": "The resource operated InputFile is bad",
    "State": "Complete",
    "OutputDetails": [
      {
        "Status": "Success",
        "TaskId": "******4215e042b3966ca5441e******",
        "Message": "The resource operated InputFile is bad\n",
        "FinishTime": "2024-12-07T13:01:07Z",
        "CreateTime": "2024-12-07T06:06:58Z",
        "Code": "InvalidParameter.ResourceContentBad\n",
        "Name": "720P-mp4",
        "Result": {
          "OutputFile": {
            "Type": "OSS",
            "Media": "oss://bucket/path/to/video.mp4\n",
            "Url": "oss://bucket/path/to/video.mp4"
          },
          "OutFileMeta": {
            "VideoStreamInfoList": [
              {
                "Rotate": "0",
                "Codec_tag": "0x001b",
                "Sar": "478:477",
                "Start_time": "1.473556",
                "Fps": "25.0",
                "Index": "0",
                "Duration": "403.039989",
                "Lang": "cn",
                "Codec_long_name": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
                "PixFmt": "yuv420p",
                "Bit_rate": "888.563",
                "Profile": "High",
                "Has_b_frames": "2",
                "Codec_time_base": "1/50",
                "Dar": "16:9",
                "Avg_fps": "25.0",
                "Codec_tag_string": "[27][0][0][0]",
                "Codec_name": "h264",
                "Height": "478",
                "Level": "31",
                "Time_base": "1/90000",
                "Width": "848",
                "NumFrames": "10040"
              }
            ],
            "AudioStreamInfoList": [
              {
                "CodecTag": "0x000f",
                "CodecTimeBase": "1/44100",
                "ChannelLayout": "stereo",
                "StartTime": "1.473556",
                "Index": "1",
                "Duration": "403.039989",
                "Lang": "cn",
                "SampleFmt": "fltp",
                "CodecName": "aac",
                "Bitrate": "0.f",
                "Channels": "2",
                "Timebase": "1/90000",
                "CodecTagString": "[15][0][0][0]",
                "SampleRate": "44100",
                "CodecLongName": "AAC (Advanced Audio Coding)"
              }
            ],
            "FileBasicInfo": {
              "FileUrl": "http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8",
              "FileStatus": "Normal",
              "MediaId": "9066406c306771f0bfa35107e0c90102",
              "FileType": "source_file",
              "FileName": "file.m3u8",
              "Region": "cn-shanghai",
              "FormatName": "hls,applehttp",
              "Duration": "403.039999",
              "Height": "478",
              "Bitrate": "888.563",
              "Width": "848",
              "FileSize": "31737"
            }
          }
        }
      }
    ],
    "OutputGroupDetails": [
      {
        "Status": "Success",
        "TaskId": "******22dad741d086a50325f9******",
        "Message": "The resource operated \"InputFile\" is bad",
        "FinishTime": "2025-03-21T01:48:41Z\n",
        "CreateTime": "2025-03-21T01:48:41Z",
        "Outputs": [
          {
            "Status": "Success",
            "TaskId": "******4215e042b3966ca5441e******",
            "Message": "The resource operated InputFile is bad\n",
            "FinishTime": "2024-12-07T13:01:07Z",
            "CreateTime": "2024-12-07T06:06:58Z",
            "Code": "InvalidParameter.ResourceContentBad\n",
            "Name": "720P-mp4",
            "Result": {
              "OutputFile": {
                "Type": "OSS",
                "Media": "oss://bucket/path/to/video.mp4\n",
                "Url": "oss://bucket/path/to/video.mp4"
              },
              "OutFileMeta": {
                "VideoStreamInfoList": [
                  {
                    "Rotate": "0",
                    "Codec_tag": "0x001b",
                    "Sar": "478:477",
                    "Start_time": "1.473556",
                    "Fps": "25.0",
                    "Index": "0",
                    "Duration": "403.039989",
                    "Lang": "cn",
                    "Codec_long_name": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
                    "PixFmt": "yuv420p",
                    "Bit_rate": "888.563",
                    "Profile": "High",
                    "Has_b_frames": "2",
                    "Codec_time_base": "1/50",
                    "Dar": "16:9",
                    "Avg_fps": "25.0",
                    "Codec_tag_string": "[27][0][0][0]",
                    "Codec_name": "h264",
                    "Height": "478",
                    "Level": "31",
                    "Time_base": "1/90000",
                    "Width": "848",
                    "NumFrames": "10040"
                  }
                ],
                "AudioStreamInfoList": [
                  {
                    "CodecTag": "0x000f",
                    "CodecTimeBase": "1/44100",
                    "ChannelLayout": "stereo",
                    "StartTime": "1.473556",
                    "Index": "1",
                    "Duration": "403.039989",
                    "Lang": "cn",
                    "SampleFmt": "fltp",
                    "CodecName": "aac",
                    "Bitrate": "0.f",
                    "Channels": "2",
                    "Timebase": "1/90000",
                    "CodecTagString": "[15][0][0][0]",
                    "SampleRate": "44100",
                    "CodecLongName": "AAC (Advanced Audio Coding)"
                  }
                ],
                "FileBasicInfo": {
                  "FileUrl": "http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8",
                  "FileStatus": "Normal",
                  "MediaId": "9066406c306771f0bfa35107e0c90102",
                  "FileType": "source_file",
                  "FileName": "file.m3u8",
                  "Region": "cn-shanghai",
                  "FormatName": "hls,applehttp",
                  "Duration": "403.039999",
                  "Height": "478",
                  "Bitrate": "888.563",
                  "Width": "848",
                  "FileSize": "31737"
                }
              }
            }
          }
        ],
        "Code": "InvalidParameter.ResourceContentBad",
        "Name": "hls-group"
      }
    ],
    "Percent": 0,
    "CreateTime": "2024-12-07T13:01:07Z\n",
    "FinishTime": "2024-12-07T13:01:07Z\n"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.