ci:CreateMediaJobs permission is required. For details, see Cloud Infinite action.cam:passrole permission is required. The asynchronous processing interface performs read and write operations on COS resources through the "role" in CAM. The PassRole permission is used for role passing. For details, refer to Access Management - Write Operation - PassRole API.POST /jobs HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml<body>
<Request><Tag>Transcode</Tag><Input><Object>input/demo.mp4</Object></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><Subtitles><Subtitle><Url>https://test-xxx.cos.ap-chongqing.myqcloud.com/test1.srt</Url></Subtitle><Subtitle><Url>https://test-xxx.cos.ap-chongqing.myqcloud.com/test2.srt</Url></Subtitle></Subtitles><DigitalWatermark><Type>Text</Type><Message>123456789ab</Message><Version>V1</Version><IgnoreError>false</IgnoreError></DigitalWatermark><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON</CallBackFormat></Request>
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
Request | None. | Container for saving requests | Container | Yes |
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
Tag | Request | Create task Tag: Transcode | String | Yes |
Input | Request | File information to be operated | Container | Yes |
Operation | Request | Operation rule | Container | Yes |
QueueType | Request | Queue type of the task, limited to SpeedTranscoding, indicates that accelerated transcoding is enabled | String | No |
CallBackFormat | Request | Job callback format, JSON or XML, default XML, priority is higher than the queue's callback format | String | No |
CallBackType | Request | Job callback type, Url or TDMQ, default Url, priority is higher than the queue's callback type | String | No |
CallBack | Request | Job callback address, priority is higher than the queue's callback address. When set to no, it means the queue's callback address does not generate callbacks. | String | No |
CallBackMqConfig | Request | Task callback TDMQ configuration, required when CallBackType is TDMQ. For details, see CallBackMqConfig. | Container | No |
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
Object | Request.Input | file path | String | Yes |
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
TemplateId | Request.Operation | transcoding template ID | String | No |
Transcode | Request.Operation | transcoding template parameter | Container | No |
WatermarkTemplateId | Request.Operation | watermark template ID, you can pass multiple watermark template IDs, up to 3 | String array | No |
Watermark | Request.Operation | watermark template parameters, same as Request.Watermark in the create watermark template API, up to 3 can be passed | Container array | No |
RemoveWatermark | Request.Operation | Remove watermark parameters H265 and AV1 encoding do not support this parameter | Container | No |
Subtitles | Request.Operation | Subtitle parameter H265, AV1 encoding and non-mkv packaging do not support this parameter | Container | No |
DigitalWatermark | Request.Operation | Container | No | |
Output | Request.Operation | Output configuration | Container | Yes |
UserData | Request.Operation | Pass through user information Printable ASCII code Length not exceeding 1024 | String | No |
JobLevel | Request.Operation | Task priority, level limit: 0, 1, 2. Higher levels indicate higher task priority, default is 0. | String | No |
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
TimeInterval | Request.Operation.Transcode | Container | No | |
Container | Request.Operation.Transcode | Container | No | |
Video | Request.Operation.Transcode | Container | No | |
Audio | Request.Operation.Transcode | Container | No | |
TransConfig | Request.Operation.Transcode | Container | No | |
AudioMix | Request.Operation.Transcode | Container | No | |
AudioMixArray | Request.Operation.Transcode | Audio mix parameter array, up to 2 can be passed simultaneously | Container array | No |
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
Dx | Request.Operation.RemoveWatermark | Offset from the top-left origin point by x, range [1, 4096] | string | Yes |
Dy | Request.Operation.RemoveWatermark | y offset from the top-left origin point, range [1, 4096] | string | Yes |
Width | Request.Operation.RemoveWatermark | Width, range [1, 4096] | string | Yes |
Height | Request.Operation.RemoveWatermark | Height, range [1, 4096] | string | Yes |
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
Subtitle | Request.Operation.Subtitles | Subtitle parameter | Container array | Yes |
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
Url | Request.Operation.Subtitles.Subtitle | Subtitle address for the same bucket Supports srt and vtt formats Requires encoding | string | Yes |
Embed | Request.Operation.Subtitles.Subtitle | Whether to enable hard subtitles. The value ranges from true to false. The default value is false. | string | No |
FontType | Request.Operation.Subtitles.Subtitle | font type, refer to FontType table. Required when Embed is true. | string | No |
FontSize | Request.Operation.Subtitles.Subtitle | Font size, value range: [5 100], unit px. Required when Embed is true. | string | No |
FontColor | Request.Operation.Subtitles.Subtitle | text color, format: 0xRRGGBB. Required when Embed is true. | string | No |
OutlineColor | Request.Operation.Subtitles.Subtitle | Contour color, format: 0xRRGGBB. Required when Embed is true. | string | No |
VMargin | Request.Operation.Subtitles.Subtitle | Percentage of subtitle distance from the bottom edge of the video, in the range of [1, 100]. Required when Embed is true. | string | No |
Font Name | Supported Languages | Description |
simfang.ttf | Create and bind a policy Query an instance Reset the access password of an instance | FangSong |
simhei.ttf | Create and bind a policy Query an instance Reset the access password of an instance | Blackbody |
simkai.ttf | Create and bind a policy Query an instance Reset the access password of an instance | KaiTi |
simsun.ttc | Create and bind a policy Query an instance Reset the access password of an instance | Song Typeface |
STHeiti-Light.ttc | Create and bind a policy Query an instance Reset the access password of an instance | STHeiti |
STHeiti-Medium.ttc | Create and bind a policy Query an instance Reset the access password of an instance | STHeiti |
youyuan.TTF | Create and bind a policy Query an instance Reset the access password of an instance | YouYuan |
ahronbd.ttf | Create and bind a policy Query an instance Reset the access password of an instance | None. |
ariblk.ttf | Create and bind a policy Query an instance Reset the access password of an instance | None. |
arial.ttf | Create and bind a policy Query an instance Reset the access password of an instance | None. |
Helvetica.dfont | Create and bind a policy Query an instance Reset the access password of an instance | None. |
HelveticaNeue.dfont | Create and bind a policy Query an instance Reset the access password of an instance | None. |
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
Region | Request.Operation.Output | Region of the storage bucket | String | Yes |
Bucket | Request.Operation.Output | Bucket for storing results | String | Yes |
Object | Request.Operation.Output | Filename of the output result | String | Yes |
Wildcard | Meaning |
${ext} | encapsulation format |
${jobid} | Task Id |
<Response><JobsDetail><Code>Success</Code><Message/><JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId><State>Submitted</State><Progress>0</Progress><CreationTime>2022-06-27T15:23:10+0800</CreationTime><StartTime>-</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><TemplateName>trans_993874</TemplateName><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId><RemoveWatermark><Dx>150</Dx><Dy>150</Dy><Width>75</Width><Height>75</Height></RemoveWatermark><Subtitles><Subtitle><Url>https://test-xxx.cos.ap-chongqing.myqcloud.com/test1.srt</Url></Subtitle><Subtitle><Url>https://test-xxx.cos.ap-chongqing.myqcloud.com/test2.srt</Url></Subtitle></Subtitles><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.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>
Node Name (Keyword) | Parent Node | Description | Type |
Response | None. | Container for saving results | Container |
Node Name (Keyword) | Parent Node | Description | Type |
JobsDetail | Response | Task details | Container array |
Node Name (Keyword) | Parent Node | Description | Type |
Code | Response.JobsDetail | Error code, meaningful only when State is Failed. | String |
Message | Response.JobsDetail | Error description, meaningful only when State is Failed. | String |
JobId | Response.JobsDetail | Newly created task ID | String |
Tag | Response.JobsDetail | Newly created task Tag: Transcode | String |
State | Response.JobsDetail | Task Status Submitted: pending execution Running: Executing Success: Execution successful Failed: Execution failed Pause: Task is paused. When the pause queue is triggered, to-be-executed tasks will become paused state. Cancel: Task execution cancelled | String |
Progress | Response.JobsDetail | Task progress percentage, range [0, 100] | 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 | String | |
Input | Response.JobsDetail | Input resource address of the task | Container |
Operation | Response.JobsDetail | Rules of the task | Container |
Node Name (Keyword) | Parent Node | Description | Type |
Region | Response.JobsDetail.Input | Region of the storage bucket | String |
Bucket | Response.JobsDetail.Input | Bucket for storing results | String |
Object | Response.JobsDetail.Input | Filename of the output result | String |
Node Name (Keyword) | Parent Node | Description | Type |
TemplateId | Response.JobsDetail.Operation | Task template ID | String |
TemplateName | Response.JobsDetail.Operation | Task template name, return when TemplateId exists | String |
Transcode | Response.JobsDetail.Operation | In-request Request.Operation.Transcode | Container |
Watermark | Response.JobsDetail.Operation | Request.Operation.Watermark | Container array |
WatermarkTemplateId | Response.JobsDetail.Operation | Request.Operation.WatermarkTemplateId | String array |
RemoveWatermark | Response.JobsDetail.Operation | Remove watermark from in-progress Request | Container |
Output | Response.JobsDetail.Operation | Request.Operation.Output | Container |
MediaInfo | Response.JobsDetail.Operation | Container | |
MediaResult | Response.JobsDetail.Operation | Basic information of the output file. For details, see MediaResult. No return if the task is incomplete. | Container |
DigitalWatermark | Response.JobsDetail.Operation | Request.Operation.DigitalWatermark | Container |
UserData | Response.JobsDetail.Operation | in-progress Request's Operation.UserData | String |
JobLevel | Response.JobsDetail.Operation | In-request Request.Operation.JobLevel | String |
POST /jobs HTTP/1.1Authorization: q-sign-algorithm=sha1&q-ak=**********************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=**************************************Host: test-1234567890.ci.ap-chongqing.myqcloud.comContent-Length: 166Content-Type: application/xml<Request><Tag>Transcode</Tag><Input><Object>input/demo.mp4</Object></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><Subtitles><Subtitle><Url>https://test-xxx.cos.ap-chongqing.myqcloud.com/test1.srt</Url></Subtitle><Subtitle><Url>https://test-xxx.cos.ap-chongqing.myqcloud.com/test2.srt</Url></Subtitle></Subtitles><DigitalWatermark><Type>Text</Type><Message>123456789ab</Message><Version>V1</Version><IgnoreError>false</IgnoreError></DigitalWatermark><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON</CallBackFormat></Request>
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 230Connection: keep-aliveDate: Mon, 28 Jun 2022 15:23:12 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response><JobsDetail><Code>Success</Code><Message/><JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId><State>Submitted</State><Progress>0</Progress><CreationTime>2022-06-27T15:23:11+0800</CreationTime><StartTime>-</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><TemplateName>trans_993874</TemplateName><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId><RemoveWatermark><Dx>150</Dx><Dy>150</Dy><Width>75</Width><Height>75</Height></RemoveWatermark><Subtitles><Subtitle><Url>https://test-xxx.cos.ap-chongqing.myqcloud.com/test1.srt</Url></Subtitle><Subtitle><Url>https://test-xxx.cos.ap-chongqing.myqcloud.com/test2.srt</Url></Subtitle></Subtitles><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.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>
POST /jobs HTTP/1.1Authorization:q-sign-algorithm=sha1&q-ak=**********************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=**************************************Host: test-1234567890.ci.ap-chongqing.myqcloud.comContent-Length: 166Content-Type: application/xml<Request><Tag>Transcode</Tag><Input><Object>input/demo.mp4</Object></Input><Operation><Transcode><Container><Format>mp4</Format></Container><Video><Codec>H.264</Codec><Profile>high</Profile><Bitrate>1000</Bitrate><Width>1280</Width><Fps>30</Fps><Preset>medium</Preset></Video><Audio><Codec>aac</Codec><Samplerate>44100</Samplerate><Bitrate>128</Bitrate><Channels>4</Channels></Audio><TransConfig><AdjDarMethod>scale</AdjDarMethod><IsCheckReso>false</IsCheckReso><ResoAdjMethod>1</ResoAdjMethod></TransConfig><TimeInterval><Start>0</Start><Duration>60</Duration></TimeInterval><AudioMixArray><AudioSource>https://test-xxx.cos.ap-chongqing.myqcloud.com/mix1.mp3</AudioSource><MixMode>Once</MixMode><Replace>true</Replace><EffectConfig><EnableStartFadein>true</EnableStartFadein><StartFadeinTime>3</StartFadeinTime><EnableEndFadeout>false</EnableEndFadeout><EndFadeoutTime>0</EndFadeoutTime><EnableBgmFade>true</EnableBgmFade><BgmFadeTime>1.7</BgmFadeTime></EffectConfig></AudioMixArray><AudioMixArray><AudioSource>https://test-xxx.cos.ap-chongqing.myqcloud.com/mix2.mp3</AudioSource><MixMode>Once</MixMode><Replace>true</Replace><EffectConfig><EnableStartFadein>true</EnableStartFadein><StartFadeinTime>3</StartFadeinTime><EnableEndFadeout>false</EnableEndFadeout><EndFadeoutTime>0</EndFadeoutTime><EnableBgmFade>true</EnableBgmFade><BgmFadeTime>1.7</BgmFadeTime></EffectConfig></AudioMixArray></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>simfang.ttf</FontType><FontColor>0xRRGGBB</FontColor><Transparency>30</Transparency></Text></Watermark><RemoveWatermark><Dx>150</Dx><Dy>150</Dy><Width>75</Width><Height>75</Height></RemoveWatermark><Subtitles><Subtitle><Url>https://test-xxx.cos.ap-chongqing.myqcloud.com/test1.srt</Url></Subtitle><Subtitle><Url>https://test-xxx.cos.ap-chongqing.myqcloud.com/test2.srt</Url></Subtitle></Subtitles><DigitalWatermark><Type>Text</Type><Message>123456789ab</Message><Version>V1</Version><IgnoreError>false</IgnoreError></DigitalWatermark><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON</CallBackFormat></Request>
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 230Connection: keep-aliveDate: Mon, 28 Jun 2022 15:23:12 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response><JobsDetail><Code>Success</Code><Message/><JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId><State>Submitted</State><Progress>0</Progress><CreationTime>2022-06-27T15:23:10+0800</CreationTime><StartTime>-</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><Transcode><Container><Format>mp4</Format></Container><Video><Codec>H.264</Codec><Profile>high</Profile><Bitrate>1000</Bitrate><Width>1280</Width><Fps>30</Fps><Preset>medium</Preset></Video><Audio><Codec>aac</Codec><Samplerate>44100</Samplerate><Bitrate>128</Bitrate><Channels>4</Channels></Audio><TransConfig><AdjDarMethod>scale</AdjDarMethod><IsCheckReso>false</IsCheckReso><ResoAdjMethod>1</ResoAdjMethod></TransConfig><TimeInterval><Start>0</Start><Duration>60</Duration></TimeInterval><AudioMixArray><AudioSource>https://test-xxx.cos.ap-chongqing.myqcloud.com/mix1.mp3</AudioSource><MixMode>Once</MixMode><Replace>true</Replace><EffectConfig><EnableStartFadein>true</EnableStartFadein><StartFadeinTime>3</StartFadeinTime><EnableEndFadeout>false</EnableEndFadeout><EndFadeoutTime>0</EndFadeoutTime><EnableBgmFade>true</EnableBgmFade><BgmFadeTime>1.7</BgmFadeTime></EffectConfig></AudioMixArray><AudioMixArray><AudioSource>https://test-xxx.cos.ap-chongqing.myqcloud.com/mix2.mp3</AudioSource><MixMode>Once</MixMode><Replace>true</Replace><EffectConfig><EnableStartFadein>true</EnableStartFadein><StartFadeinTime>3</StartFadeinTime><EnableEndFadeout>false</EnableEndFadeout><EndFadeoutTime>0</EndFadeoutTime><EnableBgmFade>true</EnableBgmFade><BgmFadeTime>1.7</BgmFadeTime></EffectConfig></AudioMixArray></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><RemoveWatermark><Dx>150</Dx><Dy>150</Dy><Width>75</Width><Height>75</Height></RemoveWatermark><Subtitles><Subtitle><Url>https://test-xxx.cos.ap-chongqing.myqcloud.com/test1.srt</Url></Subtitle><Subtitle><Url>https://test-xxx.cos.ap-chongqing.myqcloud.com/test2.srt</Url></Subtitle></Subtitles><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.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>
Feedback