Traverses transcoding jobs
Operation description
- By default, the returned transcoding jobs are sorted by CreationTime in descending order.
- You can call this operation to return transcoding jobs of the last 90 days. The jobs are returned based on the specified time range.
- You can filter query results by configuring request parameters such as job status, creation time interval, and ApsaraVideo Media Processing (MPS) queue for transcoding.
- By default, MPS does not allow you to access data across regions within the same account. Before you call this operation, make sure that the region that you specify is the same as the region of the transcoding jobs to be queried. Otherwise, this operation may fail to be called, or invalid information may be returned.
QPS limits
You can call this API operation up to 100 times per second per account. Requests that exceed this limit are dropped, and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
NextPageToken | string | No | The token that is used to retrieve the next page of the query results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextPageToken. | 16f01ad6175e4230ac42bb5182cd**** |
MaximumPageSize | long | No | The number of entries per page.
| 10 |
State | string | No | The state of the transcoding job. Default value: All. Valid values:
| All |
StartOfJobCreatedTimeRange | string | No | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the | 2014-01-10T12:00:00Z |
EndOfJobCreatedTimeRange | string | No | The end of the time range to query. Specify the time in the ISO 8601 standard in the | 2014-01-11T12:00:00Z |
PipelineId | string | No | The ID of the MPS queue to which the job is submitted. To obtain the ID of an MPS queue, you can log on to the MPS console and choose Global Settings > MPS Queue and Callback in the left-side navigation pane. | 88c6ca184c0e424d5w5b665e2a12**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "BC860F04-778A-472F-AB39-E1BF329C1EA8",
"NextPageToken": "16f01ad6175e4230ac42bb5182cd****",
"JobList": {
"Job": [
{
"CreationTime": "2014-01-10T12:00:00Z",
"Percent": 100,
"FinishTime": "2014-01-10T12:20:25Z",
"State": "TranscodeSuccess",
"JobId": "31fa3c9ca8134fb4b0b0f7878301****",
"Code": "InternalError",
"Message": "The operation has failed due to some unknown error, exception or failure.",
"Output": {
"Video": {
"Bufsize": "6000",
"Degrain": "5",
"BitrateBnd": {
"Max": "1000",
"Min": "200"
},
"PixFmt": "yuv420p",
"Pad": "1280:800:0:140",
"Codec": "H.264",
"Height": "720",
"Qscale": "15",
"Crop": "border",
"Bitrate": "428",
"Maxrate": "1000",
"MaxFps": "60",
"Profile": "high",
"Crf": "26",
"Gop": "250",
"Width": "1280",
"Fps": "25",
"Preset": "medium",
"ScanMode": "interlaced",
"ResoPriority": "1"
},
"TransConfig": {
"IsCheckAudioBitrate": "false",
"TransMode": "onepass",
"IsCheckReso": "false",
"IsCheckVideoBitrateFail": "false",
"AdjDarMethod": "none",
"IsCheckVideoBitrate": "false",
"IsCheckResoFail": "false",
"IsCheckAudioBitrateFail": "false"
},
"Encryption": {
"Type": "hls-aes-128",
"Key": "encryptionkey128",
"KeyType": "Base64",
"Id": "31fa3c9ca8134f9cec2b4b0b0f78****",
"KeyUri": "https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/",
"SkipCnt": "3"
},
"WaterMarkList": {
"WaterMark": [
{
"Type": "Image",
"ReferPos": "TopRight",
"Dx": "100",
"Width": "50",
"Height": "50",
"InputFile": {
"Object": "example-logo-****.png",
"Location": "oss-cn-hangzhou",
"Bucket": "example-bucket"
},
"WaterMarkTemplateId": "88c6ca184c0e47098a5b665e2a12****",
"Dy": "100"
}
]
},
"WaterMarkConfigUrl": "http://example.com/configure",
"DeWatermark": "{\"0\": [{\"l\": 10,\"t\": 10,\"w\": 10,\"h\": 10},{\"l\": 100,\"t\": 0.1,\"w\": 10,\"h\": 10}],\"128000\": [],\"250000\": [{\"l\": 0.2,\"t\": 0.1,\"w\": 0.01,\"h\": 0.05}]}",
"M3U8NonStandardSupport": {
"TS": {
"SizeSupport": true,
"Md5Support": true
}
},
"Priority": "6",
"Audio": {
"Profile": "aaclow",
"Codec": "aac",
"Samplerate": "44100",
"Qscale": "15",
"Channels": "2",
"Volume": {
"Method": "auto",
"Level": "-20"
},
"Bitrate": "128"
},
"AudioStreamMap": "0:a:0",
"MergeList": {
"Merge": [
{
"Start": "",
"RoleArn": "acs:ram::<your uid>:role/<your role name>",
"MergeURL": "http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv",
"Duration": "01:59:59.999"
}
]
},
"SuperReso": {
"IsHalfSample": "true"
},
"UserData": "test-001",
"OutSubtitleList": {
"OutSubtitle": [
{
"Map": "0:v:0",
"OutSubtitleFile": {
"RoleArn": "acs:ram::<your uid>:role/<your role name>",
"Object": "example-output.flv",
"Location": "oss-cn-hangzhou",
"Bucket": "example-bucket-****"
},
"Success": true,
"Message": "The specified parameter “%s” cannot be null."
}
]
},
"VideoStreamMap": "0:a:0",
"OutputFile": {
"RoleArn": "acs:ram::<your uid>:role/<your role name>",
"Object": "example-output.flv",
"Location": "oss-cn-hangzhou",
"Bucket": "example-bucket"
},
"Rotate": "90",
"Container": {
"Format": "flv"
},
"Clip": {
"TimeSpan": {
"Seek": "01:00:59.999",
"Duration": "01:00:59.999"
}
},
"MergeConfigUrl": "{\"MergeList\":[{\"MergeURL\":\"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4\"}]}",
"OpeningList": {
"Opening": [
{
"openUrl": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv",
"Start": "0",
"Width": "-1",
"Height": "-1"
}
]
},
"MuxConfig": {
"Webp": {
"Loop": "0"
},
"Gif": {
"FinalDelay": "0",
"DitherMode": "bayer",
"Loop": "0",
"IsCustomPalette": "true"
},
"Segment": {
"Duration": "10"
}
},
"TailSlateList": {
"TailSlate": [
{
"Start": "1",
"BgColor": "White",
"IsMergeAudio": true,
"Width": "-1",
"Height": "-1",
"BlendDuration": "0",
"TailUrl": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv"
}
]
},
"TemplateId": "S00000000-000010",
"SubtitleConfig": {
"ExtSubtitleList": {
"ExtSubtitle": [
{
"CharEnc": "auto",
"FontName": "\"WenQuanYi Zen Hei\", \"Yuanti SC Regular\", \"SimSun\"",
"Input": {
"Object": "example-output.flv",
"Location": "oss-cn-hangzhou",
"Bucket": "example-bucket-****"
}
}
]
},
"SubtitleList": {
"Subtitle": [
{
"Map": "0"
}
]
}
},
"Properties": {
"Width": "720",
"Height": "1280",
"Duration": "17",
"Fps": "30",
"Bitrate": "490",
"FileFormat": "mp4",
"Streams": {
"VideoStreamList": {
"VideoStream": [
{
"Index": "0",
"Timebase": "1/15360",
"AvgFPS": "30.0",
"PixFmt": "yuv420p",
"Sar": "1:1",
"Lang": "und",
"CodecLongName": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
"Height": "1280",
"NumFrames": "30",
"Bitrate": "421.117",
"CodecTagString": "avc1",
"HasBFrames": "2",
"Profile": "high",
"StartTime": "0.000000",
"NetworkCost": {
"PreloadTime": "8",
"AvgBitrate": "300",
"CostBandwidth": "10"
},
"Dar": "9:16",
"CodecName": "h264",
"Width": "720",
"Duration": "17.233333",
"Fps": "30.0",
"CodecTag": "0x31637661",
"CodecTimeBase": "1/60",
"Level": "31"
}
]
},
"AudioStreamList": {
"AudioStream": [
{
"Timebase": "1/32000",
"Index": "1",
"SampleFmt": "fltp",
"ChannelLayout": "mono",
"Lang": "und",
"Samplerate": "32000",
"CodecLongName": "AAC (Advanced Audio Coding)",
"Channels": "1",
"NumFrames": "30",
"Bitrate": "64.136",
"CodecTagString": "mp4a",
"StartTime": "0.000000",
"CodecName": "aac",
"Duration": "17.223562",
"CodecTag": "0x6134706d",
"CodecTimeBase": "1/32000"
}
]
},
"SubtitleStreamList": {
"SubtitleStream": [
{
"Index": "1",
"Lang": "und"
}
]
}
},
"Format": {
"StartTime": "0.064000",
"NumPrograms": "0",
"Size": "1057273",
"NumStreams": "2",
"FormatLongName": "QuickTime / MOV",
"Duration": "17.234000",
"Bitrate": "490.784",
"FormatName": "mov"
},
"FileSize": "1057273"
}
},
"PipelineId": "88c6ca184c0e47b665e2a1267971****",
"Input": {
"Object": "example.flv",
"Location": "oss-cn-hangzhou",
"Bucket": "example-bucket"
},
"MNSMessageResult": {
"MessageId": "123",
"ErrorMessage": "The resource operated “%s” cannot be found.",
"ErrorCode": "InvalidParameter.ResourceNotFound"
}
}
]
}
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|