All Products
Search
Document Center

Intelligent Media Services:SubmitMediaConvertJob

Last Updated:Dec 08, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Submits a transcoding task.

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.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
ice:SubmitMediaConvertJobnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

The idempotency key that is used to ensure repeated requests have the same effect as a single request.

86f8e525-9d73-4dac-88aa-7aa4e950c00a
ConfigstringYes

The configurations of the transcoding task.

{ "Inputs": [{ "InputFile": { "Type": "OSS", "Media": "http://**.oss-cn-shanghai.aliyuncs.com/input/**/60min.mp4" } }], "Outputs": [{ "OutputFile": { "Type": "OSS", "Media": "http://**.oss-cn-shanghai.aliyuncs.com/output/**/360p.mp4" }, "TemplateId": "S00000001-200000" }, { "OutputFile": { "Type": "OSS", "Media": "http://**.oss-cn-shanghai.aliyuncs.com/output/**/720p.mp4" }, "TemplateId": "S00000001-200000" }] }
UserDatastringNo

The user data.

{"videoId":"abcd"}
PipelineIdstringNo

The ID of the queue.

e197ecfb103e4849922b054d3032f954

Response parameters

ParameterTypeDescriptionExample
object

The result of transcoding task submission.

RequestIdstring

The ID of the request.

******11-DB8D-4A9A-875B-275798******
Jobobject

The transcoding task.

RequestIdstring

The ID of the request.

A2129C9F-CE95-58B5-B8C1-07758FF6C86F
ClientTokenstring

The idempotency key of the request for creating the transcoding task.

FB7F25E9-AD9B-1603-8AF6-F1E42DF2E706
JobIdstring

The ID of the transcoding task.

****20b48fb04483915d4f2cd8ac****
Configobject

The configurations of the transcoding task.

Inputsarray

The inputs of the transcoding task.

inputMediaConvertInput

The input of the transcoding task.

[{\"Src\":{\"Type\":\"MAP_SERVICE\",\"DataId\":\"479f6c63f66dcc1a9a09420fee32cbdf\",\"ZoomLevel\":18},\"Idx\":1}]
Outputsarray

The output configurations.

outputMediaConvertOutput

The output configuration.

[]
OutputGroupsarray

The output group configurations.

groupMediaConvertOutputGroup

The output group configuration.

JobNamestring

The name of the job.

insx6-1310
PipelineIdstring

The ID of the queue.

3780049
UserDatastring

The user data.

{"videoId":"abcd"}
Codestring

The error code returned when the transcoding task failed.

200
Messagestring

The error message returned when the transcoding task failed.

ok
Statestring

The status of the transcoding task. Valid values:

  • Inited: The task is initialized.
  • Running
  • Complete
  • Error
  • Cancelled
Inited
OutputDetailsarray

The details of the transcoded outputs.

outputDetailMediaConvertOutputDetail

The details of the transcoded output.

OutputGroupDetailsarray

The details of the output groups.

outputGroupDetailMediaConvertOutputGroupDetail

The details of the output group.

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Job": {
    "RequestId": "A2129C9F-CE95-58B5-B8C1-07758FF6C86F",
    "ClientToken": "FB7F25E9-AD9B-1603-8AF6-F1E42DF2E706",
    "JobId": "****20b48fb04483915d4f2cd8ac****",
    "Config": {
      "Inputs": [
        {
          "Name": "InputVideo",
          "InputFile": {
            "Type": "OSS",
            "Media": "http://bucket.loction.aliyuncs.com/path/to/video.mp4",
            "Url": ""
          }
        }
      ],
      "Outputs": [
        {
          "OutputFile": {
            "Type": "OSS",
            "Media": "http://bucket.loction.aliyuncs.com/path/to/video.mp4",
            "Url": ""
          },
          "Priority": 6,
          "OverrideParams": {},
          "Features": {},
          "TemplateId": "****96e8864746a0b6f3****",
          "Name": "output-video"
        }
      ],
      "OutputGroups": [
        {
          "GroupConfig": {
            "OutputFileBase": {
              "Type": "OSS",
              "Media": "http://bucket.loction.aliyuncs.com/path/to/video.mp4",
              "Url": ""
            },
            "ManifestName": "manifest",
            "Type": "Hls"
          },
          "Outputs": [
            {
              "Priority": 6,
              "OverrideParams": {},
              "Features": {},
              "OutputFileName": "720p.mp4",
              "TemplateId": "****96e8864746a0b6f3****\n",
              "Name": "group-output"
            }
          ],
          "Name": "hls-group"
        }
      ],
      "JobName": "insx6-1310"
    },
    "PipelineId": 3780049,
    "UserData": {
      "videoId": "abcd"
    },
    "Code": 200,
    "Message": "ok",
    "State": "Inited",
    "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,
                "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,
                "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,
                    "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,
                    "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"
      }
    ]
  }
}

Error codes

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