This API (CreateMediaJobs
) is used to submit a task.
POST /jobs HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml
<body>
Note:Authorization: Auth String (For more information, please see Request Signature.)
This API only uses Common Request Headers.
This request requires the following request body:
<Request>
<Tag>Transcode</Tag>
<Input>
<Object></Object>
</Input>
<Operation>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<Output>
<Region></Region>
<Bucket></Bucket>
<Object></Object>
</Output>
</Operation>
<QueueId></QueueId>
<CallBack></CallBack>
</Request>
The nodes are described as follows:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
Request | None | Request container | Container | Yes |
Request
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
Tag | Request | Task type: Transcode | String | Yes |
Input | Request | Information about the media to be operated | Container | Yes |
Operation | Request | Operation rule. Up to 6 tasks can be performed on the same file. | Container | Yes |
QueueId | Request | ID of the queue where the task is in | String | Yes |
CallBack | Request | Callback address | String | Yes |
Input
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
Object | Request.Input | Media filename | String | Yes |
Operation
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
Transcode | Request.Operation | Transcoding template parameters | Container | No |
Watermark | Request.Operation | Watermark template parameters. Same as Request.Watermark in the watermark template creation API CreateMediaTemplate . |
Container | No |
RemoveWatermark | Request.Operation | Whether to remove the watermark | Container | No |
TemplateId | Request.Operation | Template ID | String | No |
WatermarkTemplateId | Request.Operation | Watermark template ID. Multiple watermark template IDs are supported. | String | No |
Output | Request.Operation | Result output address | Container | Yes |
Note:
TemplateId
is used with priority. IfTemplateId
is unavailable, the corresponding task type parameter is used.
Transcode
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
Container | Request.Operation.Transcode | Same as Request.Container in the transcoding template creation API CreateMediaTemplate . |
Container | No |
Video | Request.Operation.Transcode | Same as Request.Video in the transcoding template creation API CreateMediaTemplate . |
Container | No |
TimeInterval | Request.Operation.Transcode | Same as Request.TimeInterval in the transcoding template creation API CreateMediaTemplate . |
Container | No |
Audio | Request.Operation.Transcode | Same as Request.Audio in the transcoding template creation API CreateMediaTemplate . |
Container | No |
TransConfig | Request.Operation.Transcode | Same as Request.TransConfig in the transcoding template creation API CreateMediaTemplate . |
Container | No |
RemoveWatermark
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
Dx | Request.Operation.RemoveWatermark | X-axis offset of the top-left corner origin. Value range: [1, 4096] | string | Yes |
Dy | Request.Operation.RemoveWatermark | Y-axis offset of the top-left corner origin. Value range: [1, 4096] | string | Yes |
Width | Request.Operation.RemoveWatermark | Width. Value range: [1, 4096] | string | Yes |
Height | Request.Operation.RemoveWatermark | Height. Value range: [1, 4096] | string | Yes |
Output
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
Region | Request.Operation.Output | Bucket region | String | Yes |
Bucket | Request.Operation.Output | Result storage bucket | String | Yes |
Object | Request.Operation.Output | Result file name | String | Yes |
This API only returns Common Response Headers.
The response body returns application/xml data. The following contains all the nodes:
<Response>
<JobsDetail>
<Code></Code>
<Message></Message>
<JobId></JobId>
<State></State>
<CreationTime></CreationTime>
<EndTime></EndTime>
<QueueId></QueueId>
<Tag>Transcode</Tag>
<Input>
<Object></Object>
</Input>
<Operation>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId>
<WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId>
<WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId>
<Output>
<Region></Region>
<Bucket></Bucket>
<Object></Object>
</Output>
<MediaInfo>
</MeidaInfo>
</Operation>
</JobsDetail>
</Response>
The nodes are described as follows:
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 | Task details | Container |
JobsDetail
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
Code | Response.JobsDetail | Error code, which is meaningful only if State is Failed |
String |
Message | Response.JobsDetail | Error description, which is meaningful only if State is Failed |
String |
JobId | Response.JobsDetail | Task ID | String |
Tag | Response.JobsDetail | Task type: Transcode | String |
State | Response.JobsDetail | Task status. Valid values: Submitted , Running , Success , Failed , Pause , Cancel |
String |
CreationTime | Response.JobsDetail | Task creation time | String |
StartTime | Response.JobsDetail | Task start time | String |
EndTime | Response.JobsDetail | Task end time | String |
QueueId | Response.JobsDetail | ID of the queue where the task is in | String |
Input | Response.JobsDetail | Input resource address of the task | Container |
Operation | Response.JobsDetail | Operation rule. Up to 6 operation rules are supported. | Container |
Input
has the following sub-nodes:
Same as the Request.Input
node in the request.
Operation
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
TemplateId | Response.JobsDetail.Operation | Task template ID | String |
Output | Response.JobsDetail.Operation | File output address | Container |
MediaInfo | Response.JobsDetail.Operation | Transcoding output video information. Not returned when there is no output video. | Container |
Output
has the following sub-nodes:
Same as the Request.Operation.Output
node in the request.
MediaInfo
has the following sub-nodes:
Same as the Response.MediaInfo
node in the GenerateMediaInfo
API.
No special error message will be returned for this request. For the common error messages, please see Error Codes.
POST /jobs HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&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
Content-Length: 166
Content-Type: application/xml
<Request>
<Tag>Transcode</Tag>
<Input>
<Object>test.mp4</Object>
</Input>
<Operation>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId>
<WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId>
<WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId>
<Output>
<Region>ap-beijing</Region>
<Bucket>examplebucket-1250000000</Bucket>
<Object>test-trans.mkv</Object>
</Output>
<RemoveWatermark>
<Dx>128</Dx>
<Dy>128</Dy>
<Width>256</Width>
<Height>256</Height>
</RemoveWatermark>
</Operation>
<QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
<CallBack>https://www.callback.com</CallBack>
</Request>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
<Response>
<JobsDetail>
<Code>Success</Code>
<Message>Success</Message>
<JobId>je8f65004eb8511eaaed4f377124a303c</JobId>
<State>Submitted</State>
<CreationTime>2019-07-07T12:12:12+0800</CreationTime>
<EndTime></EndTime>
<QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
<Tag>Transcode</Tag>
<Input>
<Object>test.mp4</Object>
</Input>
<Operation>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId>
<WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId>
<WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId>
<Output>
<Region>ap-beijing</Region>
<Bucket>examplebucket-1250000000</Bucket>
<Object>test-trans.mkv</Object>
</Output>
<RemoveWatermark>
<Dx>128</Dx>
<Dy>128</Dy>
<Width>256</Width>
<Height>256</Height>
</RemoveWatermark>
</Operation>
</JobsDetail>
</Response>
POST /jobs HTTP/1.1
Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&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
Content-Length: 166
Content-Type: application/xml
<Request>
<Tag>Transcode</Tag>
<Input>
<Object>test.mp4</Object>
</Input>
<Operation>
<Transcode>
<Container>
<Format>mp4</Format>
</Container>
<Video>
<Codec>H.264</Codec>
<Profile>high</Profile>
<Bitrate>1000</Bitrate>
<Crf></Crf>
<Width>1280</Width>
<Height></Height>
<Fps>30</Fps>
<Gop></Gop>
<Preset>medium</Preset>
<ScanMode></ScanMode>
<Bufsize>0</Bufsize>
<Maxrate>0</Maxrate>
</Video>
<Audio>
<Codec>aac</Codec>
<Samplerate>44100</Samplerate>
<Bitrate>128</Bitrate>
<Channels>4</Channels>
</Audio>
<TransConfig>
<AdjDarMethod>rescale</AdjDarMethod>
<IsCheckReso>false</IsCheckReso>
<ResoAdjMethod>1</ResoAdjMethod>
</TransConfig>
<TimeInterval>
<Start>0</Start>
<Duration>60</Duration>
</TimeInterval>
</Transcode>
<Watermark>
<Type>Text</Type>
<LocMode>Absolute</LocMode>
<Dx>128</Dx>
<Dy>128</Dy>
<Pos>TopRight</Pos>
<StartTime>0</StartTime>
<EndTime>100.5</EndTime>
<Text>
<Text>Watermark content</Text>
<FontSize>30</FontSize>
<FontType></FontType>
<FontColor>0xRRGGBB</FontColor>
<Transparency>30</Transparency>
</Text>
</Watermark>
<Watermark>
<Type>Image</Type>
<LocMode>Absolute</LocMode>
<Dx>128</Dx>
<Dy>128</Dy>
<Pos>TopRight</Pos>
<StartTime>0</StartTime>
<EndTime>100.5</EndTime>
<Image>
<Url>http://examplebucket-1250000000.ci.ap-beijing.myqcloud.com/shuiyin_2.png</Url>
<Mode>Proportion</Mode>
<Width>10</Width>
<Height>10</Height>
<Transparency>30</Transparency>
</Image>
</Watermark>
<Output>
<Region>ap-beijing</Region>
<Bucket>examplebucket-1250000000</Bucket>
<Object>test-trans.gif</Object>
</Output>
</Operation>
<QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
<CallBack>https://www.callback.com</CallBack>
</Request>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
<Response>
<JobsDetail>
<Code>Success</Code>
<Message>Success</Message>
<JobId>jabcxxxxfeipplsdfwe</JobId>
<State>Submitted</State>
<CreationTime>2019-07-07T12:12:12+0800</CreationTime>
<StartTime></StartTime>
<EndTime></EndTime>
<QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
<Tag>Transcode</Tag>
<Input>
<Object>test.mp4</Object>
</Input>
<Operation>
<Transcode>
<Container>
<Format>mp4</Format>
</Container>
<Video>
<Codec>H.264</Codec>
<Profile>high</Profile>
<Bitrate>1000</Bitrate>
<Crf></Crf>
<Width>1280</Width>
<Height></Height>
<Fps>30</Fps>
<Gop></Gop>
<Preset>medium</Preset>
<ScanMode></ScanMode>
<Bufsize>0</Bufsize>
<Maxrate>0</Maxrate>
</Video>
<Audio>
<Codec>aac</Codec>
<Samplerate>44100</Samplerate>
<Bitrate>128</Bitrate>
<Channels>4</Channels>
</Audio>
<TransConfig>
<AdjDarMethod>rescale</AdjDarMethod>
<IsCheckReso>false</IsCheckReso>
<ResoAdjMethod>1</ResoAdjMethod>
</TransConfig>
<TimeInterval>
<Start>0</Start>
<Duration>60</Duration>
</TimeInterval>
</Transcode>
<Watermark>
<Type>Text</Type>
<LocMode>Absolute</LocMode>
<Dx>128</Dx>
<Dy>128</Dy>
<Pos>TopRight</Pos>
<StartTime>0</StartTime>
<EndTime>100.5</EndTime>
<Text>
<Text>Watermark content</Text>
<FontSize>30</FontSize>
<FontType></FontType>
<FontColor>0xRRGGBB</FontColor>
<Transparency>30</Transparency>
</Text>
</Watermark>
<Watermark>
<Type>Image</Type>
<LocMode>Absolute</LocMode>
<Dx>128</Dx>
<Dy>128</Dy>
<Pos>TopRight</Pos>
<StartTime>0</StartTime>
<EndTime>100.5</EndTime>
<Image>
<Url>http://examplebucket-1250000000.ci.ap-beijing.myqcloud.com/shuiyin_2.png</Url>
<Mode>Proportion</Mode>
<Width>10</Width>
<Height>10</Height>
<Transparency>30</Transparency>
</Image>
</Watermark>
<Output>
<Region>ap-beijing</Region>
<Bucket>examplebucket-1250000000</Bucket>
<Object>test-trans.mp4</Object>
</Output>
</Operation>
</JobsDetail>
</Response>
Was this page helpful?