The API (DescribeMediaJobs
) is used to pull jobs that meet specified conditions.
GET /jobs?size=&states=&queueId=&startCreationTime=&endCreationTime= HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Note:
- Authorization: Auth String (for more information, see Request Signature).
- When this feature is used by a sub-account, relevant permissions must be granted as instructed in Authorization Granularity Details.
The parameters are as described below:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
queueId | None | ID of the queue from which jobs are pulled. | String | Yes |
tag | None | Job tag | String | Yes |
workflowId | None | ID of the workflow triggering this job | String | No |
inventoryTriggerJobId | None | ID of the batch data processing job triggering this job | String | No |
inputObject | None | Name of the input file for this job, which currently supports only exact match. | String | No |
orderByTime | None | Desc (default) or Asc |
String | No |
nextToken | None | Context token for pagination | String | No |
size | None | Maximum number of jobs that can be pulled. The default value is 10. The maximum value is 100. | Integer | No |
states | None | Status of the jobs to pull. If you enter multiple job statuses, separate them by comma. Valid values: All (default), Submitted , Running , Success , Failed , Pause , Cancel . |
String | No |
startCreationTime | None | Start time of the time range for job pulling in the format of %Y-%m-%dT%H:%m:%S%z , such as 2001-01-01T00:00:00+0800 |
String | No |
endCreationTime | None | End time of the time range for job pulling in the format of %Y-%m-%dT%H:%m:%S%z , such as 2001-01-01T23:59:59+0800 |
String | No |
Supported tag
types are as follows:
Job type | tag |
---|---|
Audio/Video transcoding | Transcode |
Video-to-animated image conversion | Animation |
Screenshot | Snapshot |
Intelligent thumbnail | SmartCover |
Audio/Video splicing | Concat |
Voice/Sound separation | VoiceSeparate |
Video montage | VideoMontage |
SDR to HDR | SDRtoHDR |
Video enhancement | VideoProcess |
Super resolution | SuperResolution |
Audio/Video remuxing | Segment |
Digital watermark | DigitalWatermark |
Digital watermark extraction | ExtractDigitalWatermark |
Video tagging | VideoTag |
Media information query | MediaInfo |
Audio/Video stream separation | StreamExtract |
Video quality analysis | QualityEstimate |
Text to speech | Tts |
Audio noise cancellation | NoiseReduction |
This API only uses common request headers. For more information, see Common Request Headers.
This request does not have a request body.
This API only returns common response headers. For more information, see Common Response Headers.
The response body returns application/xml data. The following contains all the nodes:
<Response>
<JobsDetail>
...
</JobsDetail>
<NextToken></NextToken>
</Response>
The nodes are as described below:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
Response | None | Response container | Container |
Response
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
JobsDetail | Response | Job details | Container array |
NextToken | Response | Context token for pagination | String |
The content of JobsDetail
varies by job type. For more information, see the following documents:
There are no special error messages for this request. For common error messages, see Error Codes.
GET /jobs?queueId=p2242ab62c7c94486915508540933a2c6&tag=Transcode HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0**********&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057
Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 666
Connection: keep-alive
Date: Mon, 28 Jun 2022 15:23:12 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=
<Response>
<JobsDetail>
<Code>Success</Code>
</Message>
<JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId>
<State>Running</State>
<Progress>30</Progress>
<CreationTime>2022-06-27T15:23:12+0800</CreationTime>
<StartTime>2022-06-27T15:23:13+0800</StartTime>
<EndTime>-</EndTime>
<QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
<Tag>Transcode</Tag>
<Input>
<BucketId>test-123456789</BucketId>
<Object>input/demo.mp4</Object>
<Region>ap-chongqing</Region>
</Input>
<Operation>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId>
<WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId>
<WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId>
<RemoveWatermark>
<Dx>150</Dx>
<Dy>150</Dy>
<Width>75</Width>
<Height>75</Height>
</RemoveWatermark>
<DigitalWatermark>
<Type>Text</Type>
<Message>123456789ab</Message>
<Version>V1</Version>
<IgnoreError>false</IgnoreError>
<State>Running</State>
</DigitalWatermark>
<Output>
<Region>ap-chongqing</Region>
<Bucket>test-123456789</Bucket>
<Object>output/out.mp4</Object>
</Output>
<UserData>This is my data.</UserData>
<JobLevel>0</JobLevel>
</Operation>
</JobsDetail>
<JobsDetail>
<Code>Success</Code>
</Message>
<JobId>j9c0a4726f6ac11ec96aaa9b64ab18d00</JobId>
<State>Success</State>
<Progress>100</Progress>
<CreationTime>2022-06-27T15:23:12+0800</CreationTime>
<StartTime>2022-06-27T15:23:13+0800</StartTime>
<EndTime>2022-06-27T15:24:33+0800</EndTime>
<QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
<Tag>Transcode</Tag>
<Input>
<BucketId>test-123456789</BucketId>
<Object>input/demo.mp4</Object>
<Region>ap-chongqing</Region>
</Input>
<Operation>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId>
<WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId>
<WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId>
<RemoveWatermark>
<Dx>150</Dx>
<Dy>150</Dy>
<Width>75</Width>
<Height>75</Height>
</RemoveWatermark>
<DigitalWatermark>
<Type>Text</Type>
<Message>123456789ab</Message>
<Version>V1</Version>
<IgnoreError>false</IgnoreError>
<State>Running</State>
</DigitalWatermark>
<Output>
<Region>ap-chongqing</Region>
<Bucket>test-123456789</Bucket>
<Object>output/out.mp4</Object>
</Output>
<UserData>This is my data.</UserData>
<JobLevel>0</JobLevel>
<MediaInfo>
<Format>
<Bitrate>834.736000</Bitrate>
<Duration>13.654000</Duration>
<FormatLongName>QuickTime / MOV</FormatLongName>
<FormatName>mov,mp4,m4a,3gp,3g2,mj2</FormatName>
<NumProgram>0</NumProgram>
<NumStream>2</NumStream>
<Size>1424687</Size>
<StartTime>0.000000</StartTime>
</Format>
<Stream>
<Audio>
<Bitrate>104.047000</Bitrate>
<Channel>2</Channel>
<ChannelLayout>stereo</ChannelLayout>
<CodecLongName>AAC (Advanced Audio Coding)</CodecLongName>
<CodecName>aac</CodecName>
<CodecTag>0x6134706d</CodecTag>
<CodecTagString>mp4a</CodecTagString>
<CodecTimeBase>1/44100</CodecTimeBase>
<Duration>13.653311</Duration>
<Index>1</Index>
<Language>und</Language>
<SampleFmt>fltp</SampleFmt>
<SampleRate>44100</SampleRate>
<StartTime>0.000000</StartTime>
<Timebase>1/44100</Timebase>
</Audio>
<Subtitle/>
<Video>
<AvgFps>25.000000</AvgFps>
<Bitrate>763.774000</Bitrate>
<CodecLongName>H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10</CodecLongName>
<CodecName>h264</CodecName>
<CodecTag>0x31637661</CodecTag>
<CodecTagString>avc1</CodecTagString>
<CodecTimeBase>1/12800</CodecTimeBase>
<ColorPrimaries>bt470bg</ColorPrimaries>
<ColorRange>tv</ColorRange>
<ColorTransfer>smpte170m</ColorTransfer>
<Duration>12.960000</Duration>
<Fps>25.000000</Fps>
<HasBFrame>0</HasBFrame>
<Height>960</Height>
<Index>0</Index>
<Language>und</Language>
<Level>10</Level>
<NumFrames>324</NumFrames>
<PixFormat>yuv420p</PixFormat>
<Profile>High</Profile>
<RefFrames>1</RefFrames>
<Rotation>0.000000</Rotation>
<StartTime>0.000000</StartTime>
<Timebase>1/12800</Timebase>
<Width>544</Width>
</Video>
</Stream>
</MediaInfo>
<MediaResult>
<OutputFile>
<Bucket>test-123456789</Bucket>
<Region>ap-chongqing</Region>
<ObjectName>output/out.mp4</ObjectName>
<Md5Info>
<Md5>3df1f845d2ffd20a525a93ec40014d90</Md5>
<ObjectName>output/out.mp4</ObjectName>
</Md5Info>
</OutputFile>
</MediaResult>
</Operation>
</JobsDetail>
<NextToken>225508</NextToken>
</Response>
Apakah halaman ini membantu?