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

Retrieves the details of a MediaConvert 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: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 result.
RequestId	string	The request ID.	4BAEA8E8-1C16-5CD3-AC50-CCBA81A53402
Job	object	The media transcoding job.
RequestId	string	The request ID for creating the media transcoding job.	****11-DB8D-4A9A-875B-275798****
ClientToken	string	The idempotency parameter for the media transcoding job creation request.	780018cb-55ba-466d-8acc-946c0c319a0e
JobId	string	The ID of the media transcoding job, which is a 32-character string.	****4579b5e748b99a27f6d6****
Config	object	The configuration of the media transcoding job.
Inputs	array	The list of inputs for the media transcoding job.
	MediaConvertInput	The input of the media transcoding job.
Outputs	array	The list of output configurations for the media transcoding job.
	MediaConvertOutput	The output configuration of the media transcoding job.
OutputGroups	array	The list of output group configurations for the media transcoding job.
	MediaConvertOutputGroup	The output group configuration of the media transcoding job.
JobName	string	The name of the job.	job-1-20241205-102045
PipelineId	string	The pipeline ID.	83500cb2a3b94fabb0956e38d64bd16d
UserData	string	The user data.	{"videoId":"ddd333"}
Code	string	The media transcoding failure code.	InvalidParameter.ResourceContentBad
Message	string	The detailed information about the media transcoding failure.	The resource operated InputFile is bad
State	string	The status of the media transcoding job. Valid values: Inited: Initialized. Running: Running. Complete: Transcoding completed. Error: Transcoding error. Cancelled: Canceled.	Complete
OutputDetails	array	The list of media transcoding output result details, which correspond to the execution results of the transcoding output list in the transcoding configuration.
	MediaConvertOutputDetail	The media transcoding output result.
OutputGroupDetails	array	The list of media transcoding output group results, which correspond to the execution results of the transcoding output group list in the transcoding configuration.
	MediaConvertOutputGroupDetail	The media transcoding output group result.
Percent	integer	The completion percentage of the job.	0
CreateTime	string	The creation time of the job, in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2024-12-07T13:01:07Z
FinishTime	string	The completion time of the job, 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": [
        {
          "Name": "output-video",
          "OutputFile": {
            "Type": "OSS",
            "Media": "http://bucket.loction.aliyuncs.com/path/to/video.mp4"
          },
          "TemplateId": "****96e8864746a0b6f3****",
          "Priority": 6,
          "Features": "{}",
          "OverrideParams": "{}"
        }
      ],
      "OutputGroups": [
        {
          "Name": "hls-group",
          "GroupConfig": {
            "ManifestName": "manifest",
            "Type": "Hls",
            "OutputFileBase": {
              "Type": "OSS",
              "Media": "http://bucket.loction.aliyuncs.com/path/to/video.mp4"
            }
          },
          "Outputs": [
            {
              "Name": "group-output",
              "OutputFileName": "720p.mp4",
              "TemplateId": "****96e8864746a0b6f3****\n",
              "Priority": 6,
              "Features": "{}",
              "OverrideParams": "{}"
            }
          ]
        }
      ],
      "JobName": "job-1-20241205-102045"
    },
    "PipelineId": "83500cb2a3b94fabb0956e38d64bd16d",
    "UserData": "{\"videoId\":\"ddd333\"}",
    "Code": "InvalidParameter.ResourceContentBad",
    "Message": "The resource operated InputFile is bad",
    "State": "Complete",
    "OutputDetails": [
      {
        "Name": "720P-mp4",
        "TaskId": "******4215e042b3966ca5441e******",
        "Status": "Success",
        "Code": "InvalidParameter.ResourceContentBad\n",
        "Message": "The resource operated InputFile is bad\n",
        "Result": {
          "OutputFile": {
            "Type": "OSS",
            "Media": "oss://bucket/path/to/video.mp4\n",
            "Url": "oss://bucket/path/to/video.mp4"
          },
          "OutFileMeta": {
            "FileBasicInfo": {
              "MediaId": "9066406c306771f0bfa35107e0c90102",
              "FileName": "file.m3u8",
              "FileStatus": "Normal",
              "FileType": "source_file",
              "FileSize": "31737",
              "FileUrl": "http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8",
              "Region": "cn-shanghai",
              "FormatName": "hls,applehttp",
              "Duration": "403.039999",
              "Bitrate": "888.563",
              "Width": "848",
              "Height": "478"
            },
            "AudioStreamInfoList": [
              {
                "Index": "1",
                "CodecName": "aac",
                "CodecLongName": "AAC (Advanced Audio Coding)",
                "CodecTimeBase": "1/44100",
                "CodecTagString": "[15][0][0][0]",
                "CodecTag": "0x000f",
                "SampleFmt": "fltp",
                "SampleRate": "44100",
                "Channels": "2",
                "ChannelLayout": "stereo",
                "Timebase": "1/90000",
                "StartTime": "1.473556",
                "Duration": "403.039989",
                "Bitrate": "0.f",
                "Lang": "cn"
              }
            ],
            "VideoStreamInfoList": [
              {
                "Index": "0",
                "Codec_name": "h264",
                "Codec_long_name": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
                "Profile": "High",
                "Codec_time_base": "1/50",
                "Codec_tag_string": "[27][0][0][0]",
                "Codec_tag": "0x001b",
                "Width": "848",
                "Height": "478",
                "Has_b_frames": "2",
                "Sar": "478:477",
                "Dar": "16:9",
                "PixFmt": "yuv420p",
                "Level": "31",
                "Fps": "25.0",
                "Avg_fps": "25.0",
                "Time_base": "1/90000",
                "Start_time": "1.473556",
                "Duration": "403.039989",
                "Bit_rate": "888.563",
                "NumFrames": "10040",
                "Lang": "cn",
                "Rotate": "0"
              }
            ]
          }
        },
        "CreateTime": "2024-12-07T06:06:58Z",
        "FinishTime": "2024-12-07T13:01:07Z"
      }
    ],
    "OutputGroupDetails": [
      {
        "Name": "hls-group",
        "TaskId": "******22dad741d086a50325f9******",
        "Code": "InvalidParameter.ResourceContentBad",
        "Message": "The resource operated \"InputFile\" is bad",
        "Status": "Success",
        "Outputs": [
          {
            "Name": "720P-mp4",
            "TaskId": "******4215e042b3966ca5441e******",
            "Status": "Success",
            "Code": "InvalidParameter.ResourceContentBad\n",
            "Message": "The resource operated InputFile is bad\n",
            "Result": {
              "OutputFile": {
                "Type": "OSS",
                "Media": "oss://bucket/path/to/video.mp4\n",
                "Url": "oss://bucket/path/to/video.mp4"
              },
              "OutFileMeta": {
                "FileBasicInfo": {
                  "MediaId": "9066406c306771f0bfa35107e0c90102",
                  "FileName": "file.m3u8",
                  "FileStatus": "Normal",
                  "FileType": "source_file",
                  "FileSize": "31737",
                  "FileUrl": "http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8",
                  "Region": "cn-shanghai",
                  "FormatName": "hls,applehttp",
                  "Duration": "403.039999",
                  "Bitrate": "888.563",
                  "Width": "848",
                  "Height": "478"
                },
                "AudioStreamInfoList": [
                  {
                    "Index": "1",
                    "CodecName": "aac",
                    "CodecLongName": "AAC (Advanced Audio Coding)",
                    "CodecTimeBase": "1/44100",
                    "CodecTagString": "[15][0][0][0]",
                    "CodecTag": "0x000f",
                    "SampleFmt": "fltp",
                    "SampleRate": "44100",
                    "Channels": "2",
                    "ChannelLayout": "stereo",
                    "Timebase": "1/90000",
                    "StartTime": "1.473556",
                    "Duration": "403.039989",
                    "Bitrate": "0.f",
                    "Lang": "cn"
                  }
                ],
                "VideoStreamInfoList": [
                  {
                    "Index": "0",
                    "Codec_name": "h264",
                    "Codec_long_name": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
                    "Profile": "High",
                    "Codec_time_base": "1/50",
                    "Codec_tag_string": "[27][0][0][0]",
                    "Codec_tag": "0x001b",
                    "Width": "848",
                    "Height": "478",
                    "Has_b_frames": "2",
                    "Sar": "478:477",
                    "Dar": "16:9",
                    "PixFmt": "yuv420p",
                    "Level": "31",
                    "Fps": "25.0",
                    "Avg_fps": "25.0",
                    "Time_base": "1/90000",
                    "Start_time": "1.473556",
                    "Duration": "403.039989",
                    "Bit_rate": "888.563",
                    "NumFrames": "10040",
                    "Lang": "cn",
                    "Rotate": "0"
                  }
                ]
              }
            },
            "CreateTime": "2024-12-07T06:06:58Z",
            "FinishTime": "2024-12-07T13:01:07Z"
          }
        ],
        "CreateTime": "2025-03-21T01:48:41Z",
        "FinishTime": "2025-03-21T01:48:41Z\n"
      }
    ],
    "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.