edit-icon download-icon

ListJob

Last Updated: Mar 15, 2018

Description

The ListJob API lists transcoding tasks by task status, creation time range, and transcoding MPS queue. By default, tasks are sorted in descending order by CreationTime.

Request parameters

Parameter Type Required or not Description
Action String Yes API of the action, system required parameter. Set this parameter to ListJob.
NextPageToken String No Identifier of the next page, which is a 32-bit UUID.
MaximumPageSize Long No Maximum number of media workflow execution instances that can be returned. The value range is [1, 100]. The default value is 10.
State String No Transcoding task status, which has the following options: All indicates all states, Submitted indicates submitted tasks, Transcoding indicates tasks being transcoded, TranscodeSuccess indicates tasks that are successfully transcoded, TranscodeFail indicates tasks that fail to be transcoded, and TranscodeCancelled indicates tasks with canceled transcoding. The default value is All.
PipelineId String No Media Transcoding queue ID.
StartOfJobCreatedTimeRange String No Start date of the time range of creating transcoding tasks. The date format conforms to ISO 8601 and UTC time is used. The format is YYYY-MM-DDThh:mm:ssZ, for example, 2014-01-10T12:00:00Z (January 10, 2014 at 20:00:00, Beijing time).
EndOfJobCreatedTimeRange String No End date of the time range of creating transcoding tasks. The date format conforms to ISO 8601 and UTC time is used. The format is YYYY-MM-DDThh:mm:ssZ, for example, 2014-01-11T12:00:00Z (January 11, 2014 at 20:00:00, Beijing time).

Return parameters

Name Type Description
JobList AliyunJob[ ] Set of transcoding tasks
NextPageToken String Identifier of the next page, which is a 32-bit UUID.

Example

Request example

  1. http://mts.cn-hangzhou.aliyuncs.com/?StartOfJobCreatedTimeRange=2014-01-10T12%3A00%3A00Z&State=All&EndOfJobCreatedTimeRange=2014-01-11T12%3A00%3A00Z&PipelineId=88c6ca184c0e47098a5b665e2a126797&Action=ListJob&<Public parameter>

Return example

XML

  1. <ListJobResponse>
  2. <RequestId>58CBF1B8-048C-4550-B59C-F6EA57A8CEB6</RequestId>
  3. <NextPageToken>8c6ca184c0e47098a5b665e2a126797</NextPageToken>
  4. <JobList list="true">
  5. <Job>
  6. <JobId>31fa3c9ca8134f9cec2b4b0b0f787830</JobId>
  7. <Input>
  8. <Bucket>example-bucket</Bucket>
  9. <Location>oss-cn-hangzhou</Location>
  10. <Object>example.flv</Object>
  11. </Input>
  12. <Output>
  13. <OutputFile>
  14. <Bucket>example-bucket</Bucket>
  15. <Location>oss-cn-hangzhou</Location>
  16. <Object>example-output.flv</Object>
  17. </OutputFile>
  18. <TemplateId>0001-01</TemplateId>
  19. <WaterMarkList list="true">
  20. <WaterMark>
  21. <InputFile>
  22. <Bucket>example-logo-bucket</Bucket>
  23. <Location>oss-cn-hangzhou</Location>
  24. <Object>example-logo.png</Object>
  25. </InputFile>
  26. <WaterMarkTemplateId>88c6ca184c0e47098a5b665e2a126797</WaterMarkTemplateId>
  27. </WaterMark>
  28. </WaterMarkList>
  29. <Properties>
  30. <Streams>
  31. <VideoStreamList>
  32. <VideoStream>
  33. <Index>1</Index>
  34. <CodecName>h264</CodecName>
  35. <CodecLongName>H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10</CodecLongName>
  36. <Profile>High</Profile>
  37. <CodecTimeBase>1001/48000</CodecTimeBase>
  38. <CodecTagString>[0][0][0][0]</CodecTagString>
  39. <CodecTag>0x0000</CodecTag>
  40. <Width>1920</Width>
  41. <Height>1080</Height>
  42. <HasBFrames>1</HasBFrames>
  43. <Sar>1:1</Sar>
  44. <Dar>16:9</Dar>
  45. <PixFmt>yuv420p</PixFmt>
  46. <Level>41</Level>
  47. <Fps>25</Fps>
  48. <AvgFPS>24000/1001</AvgFPS>
  49. <Timebase>1/1000</Timebase>
  50. <StartTime>0.042000</StartTime>
  51. <Duration>100</Duration>
  52. <Bitrate>30541090</Bitrate>
  53. <NumFrames>100</NumFrames>
  54. <Lang>eng</Lang>
  55. <NetworkCost>
  56. <PreloadTime>8</PreloadTime>
  57. <CostBandwidth>10</CostBandwidth>
  58. <AvgBitrate>300.34</AvgBitrate>
  59. </NetworkCost>
  60. </aliyun_video_stream>
  61. </VideoStreamList>
  62. <AudioStreamList>
  63. <AudioStream>
  64. <Index>1</Index>
  65. <CodecName>dca</CodecName>
  66. <CodecTimeBase>1/48000</CodecTimeBase>
  67. <CodecLongName>DCA (DTS Coherent Acoustics)</CodecLongName>
  68. <CodecTagString>[0][0][0][0]</CodecTagString>
  69. <CodecTag>0x0000</CodecTag>
  70. <SampleFmt>fltp</SampleFmt>
  71. <Samplerate>48000</Samplerate>
  72. <Channels>2</Channels>
  73. <ChannelLayout>5.1(side)</ChannelLayout>
  74. <Timebase>1/1000</Timebase>
  75. <StartTime>0.042000</StartTime>
  76. <Duration>123</Duration>
  77. <Bitrate>1536000</Bitrate>
  78. <NumFrames>123</NumFrames>
  79. <Lang>eng</Lang>
  80. </aliyun_audio_stream>
  81. </AudioStreamList>
  82. <SubtitleStreamList>
  83. <SubtitleStream>
  84. <Index>3</Index>
  85. <Lang>eng</Lang>
  86. </aliyun_subtitle_stream>
  87. </SubtitleStreamList>
  88. </Streams>
  89. <Format>
  90. <NumStreams>1</NumStreams>
  91. <NumPrograms>2</NumPrograms>
  92. <FormatName>matroska,webm</FormatName>
  93. <FormatLongName>Matroska / WebM</FormatLongName>
  94. <StartTime>0.042000</StartTime>
  95. <Duration>17.600000</Duration>
  96. <Size>70569598</Size>
  97. <Bitrate>32077090</Bitrate>
  98. </Format>
  99. </Properties>
  100. <UserData>testid-001</UserData>
  101. </Output>
  102. <State>TranscodeSuccess</State>
  103. <Code> </Code>
  104. <Message> </Message>
  105. <Percent>100</Percent>
  106. <PipelineId>88c6ca184c0e47098a5b665e2a126797</PipelineId>
  107. <CreationTime>2014-01-10T12:00:00Z</CreationTime>
  108. </Job>
  109. </JobList>
  110. </ListJobResponse>

JSON

  1. {
  2. "NextPageToken":"8c6ca184c0e47098a5b665e2a126797",
  3. "JobList": {
  4. "Job": [{
  5. "JobId": "31fa3c9ca8134f9cec2b4b0b0f787830",
  6. "Input": {
  7. "Bucket": "example-bucket",
  8. "Location": "oss-cn-hangzhou",
  9. "Object": "example.flv"
  10. },
  11. "Output": {
  12. "OutputFile": {
  13. "Bucket": "example-bucket",
  14. "Location": "oss-cn-hangzhou",
  15. "Object": "example-output.flv"
  16. },
  17. "TemplateId": "0001-01",
  18. "WaterMarkList": {
  19. "WaterMark": [{
  20. "InputFile": {
  21. "Bucket": "example-bucket",
  22. "Location": "oss-cn-hangzhou",
  23. "Object": "example-logo.png"
  24. },
  25. "WaterMarkTemplateId": "88c6ca184c0e47098a5b665e2a126797"
  26. }]
  27. },
  28. "Properties":{
  29. "Streams":{
  30. "VideoStreamList":{
  31. "VideoStream":[
  32. {
  33. "Index":"1",
  34. "CodecName":"h264",
  35. "CodecLongName":"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
  36. "Profile":"High",
  37. "CodecTimeBase":"1001/48000",
  38. "CodecTagString":"[0][0][0][0]",
  39. "CodecTag":"0x0000",
  40. "Width":"1920",
  41. "Height":"1080",
  42. "HasBFrames":"1",
  43. "Sar":"1:1",
  44. "Dar":"16:9",
  45. "PixFmt":"yuv420p",
  46. "Level":"41",
  47. "Fps":"25",
  48. "AvgFPS":"24000/1001",
  49. "Timebase":"1/1000",
  50. "StartTime":"0.042000",
  51. "Duration":"100",
  52. "Bitrate":"30541090",
  53. "NumFrames":"100",
  54. "Lang":"eng",
  55. "NetworkCost":{
  56. "PreloadTime":"8",
  57. "CostBandwidth":"10",
  58. "AvgBitrate":"300.34"
  59. }
  60. }
  61. ]
  62. },
  63. "AudioStreamList":{
  64. "AudioStream":[
  65. {
  66. "Index":"1",
  67. "CodecName":"dca",
  68. "CodecTimeBase":"1/48000",
  69. "CodecLongName":"DCA (DTS Coherent Acoustics)",
  70. "CodecTagString":"[0][0][0][0]",
  71. "CodecTag":"0x0000",
  72. "SampleFmt":"fltp",
  73. "Samplerate":"48000",
  74. "Channels":"2",
  75. "ChannelLayout":"5.1(side)",
  76. "Timebase":"1/1000",
  77. "StartTime":"0.042000",
  78. "Duration":"123",
  79. "Bitrate":"1536000",
  80. "NumFrames":"123",
  81. "Lang":"eng"
  82. }
  83. ]
  84. },
  85. "SubtitleStreamList":{
  86. "SubtitleStream":[
  87. {
  88. "Index":"3",
  89. "Lang":"eng"
  90. }
  91. ]
  92. }
  93. },
  94. "Format":{
  95. "NumStreams":"1",
  96. "NumPrograms":"2",
  97. "FormatName":"matroska,webm",
  98. "FormatLongName":"Matroska / WebM",
  99. "StartTime":"0.042000",
  100. "Duration":"17.600000",
  101. "Size":"70569598",
  102. "Bitrate":"32077090"
  103. }
  104. },
  105. "UserData":"testid-001"
  106. },
  107. "State": "TranscodeSuccess",
  108. "Code": "",
  109. "Message": "",
  110. "Percent": 100,
  111. "PipelineId": "88c6ca184c0e47098a5b665e2a126797",
  112. "CreationTime":"2014-01-10T12:00:00Z"
  113. }]
  114. },
  115. "RequestId":"06CB45EF-903C-4464-A812-AD276948D5BB"
  116. }
Thank you! We've received your feedback.