History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
cam:PassRole 权限,异步处理接口会通过 CAM 的“角色”进行 COS 的资源读写操作,PassRole 权限用于传递角色, 具体请查看 访问管理-写操作-PassRole 接口。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><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>
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Request | 无 | 保存请求的容器 | Container | 是 |
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Tag | Request | 创建任务的 Tag:Transcode | String | 是 |
Input | Request | 待操作的文件信息 | Container | 是 |
Operation | Request | 操作规则 | Container | 是 |
CallBackFormat | Request | 任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式 | String | 否 |
CallBackType | Request | 任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型 | String | 否 |
CallBack | Request | 任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调 | String | 否 |
CallBackMqConfig | Request | Container | 否 |
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Object | Request.Input | 文件路径 | String | 是 |
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
TemplateId | Request.Operation | String | 否 | |
Transcode | Request.Operation | 转码模板参数 | Container | 否 |
WatermarkTemplateId | Request.Operation | String 数组 | 否 | |
Watermark | Request.Operation | Container 数组 | 否 | |
RemoveWatermark | Request.Operation | 去除水印参数, H.265、AV1编码暂不支持该参数 | Container | 否 |
DigitalWatermark | Request.Operation | Container | 否 | |
Output | Request.Operation | 结果输出配置 | Container | 是 |
UserData | Request.Operation | 透传用户信息, 可打印的 ASCII 码, 长度不超过1024 | String | 否 |
JobLevel | Request.Operation | 任务优先级,级别限制:0 、1 、2 。级别越大任务优先级越高,默认为0 | String | 否 |
FreeTranscode | Request.Operation | 闲时转码标记位, true/false | String | 否 |
节点名称(关键字) | 父节点 | 描述 | 类型 | 必选 | 限制 |
Container | Request.Operation.Transcode | 容器格式 | Container | 是 | 无 |
Video | Request.Operation.Transcode | 视频信息 | Container | 否 | 不传 Video,相当于删除视频信息 |
TimeInterval | Request.Operation.Transcode | 时间区间 | Container | 否 | 无 |
Audio | Request.Operation.Transcode | 音频信息 | Container | 否 | 不传 Audio,相当于删除音频信息 |
TransConfig | Request.Operation.Transcode | 转码配置 | Container | 否 | 无 |
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Format | Request.Operation.Transcode.Container | 封装格式:取值见下表 | String | 是 |
Container | Audio Codecs | Video Codecs |
mp4 | aac、mp3 | H.264、H.265、AV1 |
hls | aac、mp3 | H.264、H.265 |
flv | aac、mp3 | H.264 |
mp3 | mp3 | 不支持 |
flac | flac | 不支持 |
m4a | aac | 不支持 |
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 默认值 | 限制 |
Codec | Request.Operation.Transcode.Video | 编解码格式 | String | 否 | H.264 | H.264 H.265 AV1 |
Fps | Request.Operation.Transcode.Video | 帧率 | String | 否 | 无 | 值范围:(0, 60] 单位:fps |
Bitrate | Request.Operation.Transcode.Video | 视频输出文件的码率 | String | 否 | 无 | 值范围:[128, 35000] 单位:Kbps |
Width | Request.Operation.Transcode.Video | 宽 | String | 否 | 视频原始宽度 | 值范围:[128, 4096] 单位:px 若只设置 Width 时,按照视频原始比例计算 Height 必须为偶数 |
Height | Request.Operation.Transcode.Video | 高 | String | 否 | 视频原始高度 | 值范围:[128, 4096] 单位:px 若只设置 Height 时,按照视频原始比例计算 Width 必须为偶数 |
Gop | Request.Operation.Transcode.Video | 关键帧间最大帧数 | String | 否 | 无 | 值范围:[1, 100000] |
Crf | Request.Operation.Transcode.Video | 码率-质量控制因子 | String | 否 | 无 | 值范围:(0, 51] 如果设置了 Crf,则 Bitrate 的设置失效 当 Bitrate 为空时,默认为25 |
Remove | Request.Operation.Transcode.Video | 是否删除视频流 | String | 否 | false | true、false, 不可以与 Audio.Remove 同时为 true |
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 默认值 | 限制 |
Codec | Request.Operation.Transcode.Audio | 编解码格式 | String | 否 | aac | aac、mp3、flac |
Bitrate | Request.Operation.Transcode.Audio | 原始音频码率 | String | 否 | 无 | 单位:Kbps 值范围:[26,256] |
Samplerate | Request.Operation.Transcode.Audio | 采样率 | String | 否 | 44100 | 44100 |
Channels | Request.Operation.Transcode.Audio | 声道数 | String | 否 | 2 | 1、2 |
Remove | Request.Operation.Transcode.Audio | 是否删除源音频流 | String | 否 | false | true、false,不可以与 Video.Remove 同时为 true |
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 默认值 | 限制 |
Start | Request.Operation.Transcode.TimeInterval | 开始时间 | String | 否 | 0 | [0 视频时长] 单位为秒 支持 float 格式,执行精度精确到毫秒 |
Duration | Request.Operation.Transcode.TimeInterval | 持续时间 | String | 否 | 视频原始时长 | [0 视频时长] 单位为秒 支持 float 格式,执行精度精确到毫秒 |
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 默认值 | 限制 |
AdjDarMethod | Request.Operation.Transcode.TransConfig | 分辨率调整方式 | String | 否 | 无 | scale(拉伸)、pad(黑边填充) 当输出视频的宽高比与原视频不等时,根据此参数做分辨率的相应调整 |
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Dx | Request.Operation.RemoveWatermark | 距离左上角原点 x 偏移,范围为[1, 4096] | string | 请求中携带 RemoveWatermark 时必填 |
Dy | Request.Operation.RemoveWatermark | 距离左上角原点 y 偏移,范围为[1, 4096] | string | 请求中携带 RemoveWatermark 时必填 |
Width | Request.Operation.RemoveWatermark | 宽,范围为[1, 4096] | string | 请求中携带 RemoveWatermark 时必填 |
Height | Request.Operation.RemoveWatermark | 高,范围为[1, 4096] | string | 请求中携带 RemoveWatermark 时必填 |
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Region | Request.Operation.Output | 存储桶的地域 | String | 是 |
BucketId | Response.JobsDetail.Input | 源文件所在存储桶 | String | 是 |
Object | Response.JobsDetail.Input | 源文件的文件名 | String | 是 |
通配符 | 含义 |
${ext} | 封装格式 |
${jobid} | 任务 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><QueueType>Transcoding</QueueType><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><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>
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
节点名称(关键字) | 父节点 | 描述 | 类型 |
JobsDetail | Response | 任务的详细信息 | Container |
节点名称(关键字) | 父节点 | 描述 | 类型 |
Code | Response.JobsDetail | 错误码,当 State 为 Failed 时生效 | String |
Message | Response.JobsDetail | 错误描述,当 State 为 Failed 时生效 | String |
JobId | Response.JobsDetail | 新创建任务的 ID | String |
Tag | Response.JobsDetail | 新创建任务的 Tag:Transcode | String |
State | Response.JobsDetail | 任务的状态,为 Submitted(已提交,待执行)、Running(执行中)、Success(执行成功)、Failed(执行失败)、Pause(任务暂停)、Cancel(任务被取消执行) 其中一个 | String |
Progress | Response.JobsDetail | 任务进度百分比,只有在 State 为 Submitted、Running、Success、Pause 时生效,范围为[0, 100] | String |
CreationTime | Response.JobsDetail | 任务的创建时间 | String |
StartTime | Response.JobsDetail | 任务的开始时间 | String |
EndTime | Response.JobsDetail | 任务的结束时间 | String |
QueueId | Response.JobsDetail | 任务所属的队列 ID | String |
QueueType | Response.JobsDetail | 任务所属的队列类型 | String |
Input | Response.JobsDetail | 该任务的输入资源地址 | Container |
Operation | Response.JobsDetail | 该任务的规则 | Container |
节点名称(关键字) | 父节点 | 描述 | 类型 |
Region | Response.JobsDetail.Input | 存储桶的地域 | String |
BucketId | Response.JobsDetail.Input | 源文件所在存储桶 | String |
Object | Response.JobsDetail.Input | 源文件的文件名 | String |
节点名称(关键字) | 父节点 | 描述 | 类型 |
TemplateId | Response.JobsDetail.Operation | 任务的模板 ID | String |
TemplateName | Response.JobsDetail.Operation | 任务的模板名称, 当 TemplateId 存在时返回 | String |
Transcode | Response.JobsDetail.Operation | Container | |
WatermarkTemplateId | Response.JobsDetail.Operation | String 数组 | |
Watermark | Response.JobsDetail.Operation | Container 数组 | |
RemoveWatermark | Response.JobsDetail.Operation | Container | |
Output | Response.JobsDetail.Operation | Container | |
MediaInfo | Response.JobsDetail.Operation | Container | |
MediaResult | Response.JobsDetail.Operation | Container | |
DigitalWatermark | Response.JobsDetail.Operation | Container | |
UserData | Response.JobsDetail.Operation | 透传用户信息 | String |
JobLevel | Response.JobsDetail.Operation | 任务优先级 | 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><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><QueueType>Transcoding</QueueType><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><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></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>水印内容</Text><FontSize>30</FontSize><FontType>simfang.ttf</FontType><FontColor>0x000000</FontColor><Transparency>30</Transparency></Text></Watermark><RemoveWatermark><Dx>150</Dx><Dy>150</Dy><Width>75</Width><Height>75</Height></RemoveWatermark><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><QueueType>Transcoding</QueueType><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></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>水印内容</Text><FontSize>30</FontSize><FontType></FontType><FontColor>0x000000</FontColor><Transparency>30</Transparency></Text></Watermark><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.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>
文档反馈