You need to enable JavaScript to run this app.
文档中心
对象存储

对象存储

复制全文
下载 pdf
视频转码
QueryMediaJob
复制全文
下载 pdf
QueryMediaJob
功能描述​
此接口用于查询音视频异步任务处理状态。​
注意事项​
  • 查询音视频异步任务仅支持同步处理(x-tos-process 处理方式)。​
  • 必须拥有 GetDataProcessJob 数据处理所需的相关权限。​
请求消息样式​
​
GET /?job_type=Transcode&job_id=183535129563a53bfa710001887ae45ac629 HTTP/1.1​
Host: <bucket_name>.tos-cn-beijing.volces.com​
Date: Fri, 30 Jul 2021 08:05:36 +0000​
Authorization: <authorization_string>​
​
请求参数和消息头​
该请求使用的公共请求消息头,请参见公共参数。​
​
名称​
位置​
参数类型​
是否必选​
示例值​
说明​
job_type​
Query​
String​
是​
Transcode​
音视频任务类型,当前支持查询的任务类型有:​
  • Transcode​
  • Remux​
  • Animation​
  • VideoSnapshots​
  • VideoGeneration​
  • Concat​
  • SpeechRecognition​
  • EraseSubtitle​
job_id​
Query​
String​
是​
183535129563a53bfa710001887a********​
音视频任务 ID。​
​
请求元素​
该请求不使用消息元素。​
响应消息头​
该请求返回的公共响应消息头,请参见公共参数。​
响应元素​
公共元素​
​
名称​
参数类型​
示例值​
说明​
JobID​
String​
fa81ef2a00a2211f08a9aa5fa72ccf57a​
任务 ID。​
CreateTime​
String​
2025-11-18T20:32:54+08:00​
任务创建时间。​
StartTime​
String​
2025-11-18T20:32:55+08:00​
任务开始时间。​
EndTime​
String​
2025-11-18T20:32:55+08:00​
任务结束时间。​
State​
String​
Success​
任务状态。​
Code​
Integer​
0​
任务状态码。​
Message​
String​
Success​
任务状态消息。​
Input​
-​
-​
输入文件。​
Object​
String​
​
sample.mp4​
输入文件对象名。​
父节点:Input​
Output​
-​
-​
输出文件。​
Region​
String​
cn-beijing​
输出文件桶所在地域。​
父节点:Output​
Bucket​
String​
testbkt​
输出文件桶名。​
父节点:Output​
Object​
String​
output.mp4​
输出文件对象名。​
父节点:Output​
​
任务类型为 Transcode 时返回的额外元素​
​
名称​
参数类型​
示例值​
说明​
TranscodeConfig​
Container​
-​
视频转码的具体配置。​
Transcode​
Container​
-​
视频转码的具体配置。​
父节点:TranscodeConfig​
TimeInterval​
Container​
-​
指定视频需要转码的时段。​
父节点:Transcode​
Start​
Integer​
0​
视频开始时间,单位毫秒。​
父节点:TimeInterval​
Duration​
Integer​
1000​
视频持续时间,单位毫秒。​
说明​
如果不设置 Start 和 Duration,则会转码整个视频。​
父节点:TimeInterval​
Container​
Container​
-​
视频封装格式。​
父节点:Transcode​
Format​
String​
ts​
转码后视频文件的封装格式。取值如下:​
  • hls​
  • flv​
  • mp3​
  • aac​
  • flac​
  • m4a​
  • oga​
  • wav​
  • ac3​
  • opus​
  • pcm​
父节点:Container​
Video​
Container​
-​
视频编码。​
父节点:Transcode​
BitRate​
Integer​
1000000​
视频输出码率,单位 bps,取值范围 [10000, 50000000]。 ​
父节点:Video​
MaxBitRate​
Integer​
5000000​
视频输出最大码率,单位 bps,取值范围 [10000, 50000000]。 ​
父节点:Video​
BufferSize​
Integer​
10000000​
视频码率控制缓冲区大小,单位 bps,取值范围 [1000000, 128000000]。 ​
父节点:Video​
Codec​
String​
H.264​
视频文件的编解码格式,取值如下:​
  • H.264​
  • H.265​
父节点:Video​
Width​
Integer​
4096​
视频文件的宽度,必须为偶数,单位 px,取值范围为 [128,4096]。​
说明​
  • 如果只设置 Width ,未设置Height,将按照视频原始比例计算视频文件的高度。​
  • 如果只设置 Height ,未设置Width,将按照视频原始比例计算视频文件的宽度。父节点:Video​
Height​
Integer​
1024​
视频文件的高度,必须为偶数,单位为 px,取值范围 [128,4096]。​
父节点:Video​
Crf​
Integer​
25​
视频文件的码率。​
父节点:Video​
PixFmt​
String​
yuv420p​
视频像素格式,取值如下:​
  • yuv420p​
  • yuv420p10le​
父节点:Video​
​
任务类型为 Remux 时返回的额外元素​
​
名称​
参数类型​
示例值​
说明​
RemuxConfig​
-​
-​
音视频转封装的具体配置。​
Format ​
String​
MP4​
音视频封装格式,取值如下:​
  • mp4​
  • mkv​
  • avi​
  • ts​
  • mp3​
  • aac​
  • flac​
  • m4a​
  • oga​
  • opus​
  • hls​
父节点:RemuxConfig​
Duration​
Integer​
5000​
HLS 分片时长,单位毫秒,仅当 Format 为 hls 时有效。 ​
父节点:RemuxConfig​
TranscodeIndex ​
String​
0​
处理的流编号,指定后目的文件将只保留指定的音视频流。​
默认处理所有流。​
父节点:RemuxConfig​
AIGCMetadata ​
-​
-​
AIGC 元数据标识内容。​
  • 不为 nil 时封装格式仅支持 mp4、mp3、oga、flac、m4a、opus;​
  • AIGCMetadata 下所有字段长度限制为 2048 个 UTF-8 字符数,字符限制为 GB18030 — 2022(ASCII)中码位为 0x21 - 0x7E 的字符。​
父节点:RemuxConfig​
Label ​
String​
test_label​
生成合成标签要素,用于表示视频属于、可能、疑似为人工智能生成合成的属性信息 。​
父节点:AIGCMetadata​
ContentProducer ​
String​
test_content_producer​
生成合成服务提供者要素,内容为视频生成合成服务提供者的名称或编码。​
父节点:AIGCMetadata​
ProduceID ​
String​
test_produce_id​
内容制作编号要素,内容为视频生成合成服务提供者对该内容的唯一编号。​
父节点:AIGCMetadata​
ContentPropagator ​
String​
test_content_propagator​
内容传播服务提供者要素,内容为视频传播服务提供者的名称或编码。​
父节点:AIGCMetadata​
PropagateID ​
String​
test_propagate_id​
内容传播编号要素,内容为视频传播服务提供者对该视频的唯一编号。​
父节点:AIGCMetadata​
ReservedCode1 ​
String​
dGVzdF9yZXNlcnZlZF9jb2RlXzE=​
预留字段 1,内容为用户自主开展安全防护,保护内容、标识完整性的信息。需经过 base64 编码后传入。​
父节点:AIGCMetadata​
ReservedCode2 ​
String​
dGVzdF9yZXNlcnZlZF9jb2RlXzI=​
预留字段 2,内容为用户自主开展安全防护,保护内容、标识完整性的信息。需经过 base64 编码后传入。​
父节点:AIGCMetadata​
C2PAMetadata​
-​
-​
C2PA 元数据。 ​
父节点:RemuxConfig 或 TranscodeConfig.Transcode.Options​
AppID​
String​
536335​
云签平台申请的 AppID。 ​
父节点:C2PAMetadata​
Manifest​
Object​
-​
C2PA Manifest 内容,必须为合法 JSON 对象。 ​
父节点:C2PAMetadata​
​
任务类型为 Concat 时返回的额外元素​
​
名称​
参数类型​
示例值​
说明​
ConcatConfig​
-​
-​
音视频拼接任务配置。​
ConcatFragments​
Array of Object​
-​
待拼接片段列表。 ​
父节点:ConcatConfig​
Object​
String​
sample-1.mp4​
当前片段对象名称。 ​
父节点:ConcatFragments​
FragmentIndex​
Integer​
0​
当前片段顺序编号。 ​
父节点:ConcatFragments​
StartTime​
Integer​
0​
当前片段截取起始时间,单位毫秒。 ​
父节点:ConcatFragments​
EndTime​
Integer​
10000​
当前片段截取结束时间,单位毫秒。 ​
父节点:ConcatFragments​
Container​
-​
-​
输出容器配置。 ​
父节点:ConcatConfig​
Format​
String​
mp4​
输出封装格式。 ​
父节点:Container​
​
任务类型为 SpeechRecognition 时返回的额外元素​
​
名称​
参数类型​
示例值​
说明​
SpeechRecognitionConfig​
-​
-​
语音识别任务配置。​
Language​
String​
auto​
识别语言,取值为 zh、en、auto。 ​
父节点:SpeechRecognitionConfig​
SingleSegment​
Boolean​
false​
是否输出为单段结果。 ​
父节点:SpeechRecognitionConfig​
OutputFormat​
String​
json​
识别结果输出格式,目前仅支持 json。 ​
父节点:SpeechRecognitionConfig​
SpeechRecognitionResult​
-​
-​
语音识别任务结果。​
Text​
String​
hello world​
识别文本。 ​
父节点:SpeechRecognitionResult​
StartTime​
Number​
0​
识别结果起始时间。 ​
父节点:SpeechRecognitionResult 或 Segments​
EndTime​
Number​
10.5​
识别结果结束时间。 ​
父节点:SpeechRecognitionResult 或 Segments​
Segments​
Array of Object​
-​
分段识别结果。 ​
父节点:SpeechRecognitionResult​
​
任务类型为 EraseSubtitle 时返回的额外元素​
​
名称​
参数类型​
示例值​
说明​
EraseSubtitleConfig​
-​
-​
字幕擦除任务配置。​
Mode​
String​
Subtitle​
擦除模式,取值为 Subtitle、Text。 ​
父节点:EraseSubtitleConfig​
OutputEncodeMode​
String​
Quality​
输出编码模式,取值为 Quality、Size。 ​
父节点:EraseSubtitleConfig​
EraseRatioLocation​
Array of Object​
-​
自定义擦除区域。 ​
父节点:EraseSubtitleConfig​
TopLeftX​
Number​
0.1​
擦除框左上角 X 轴偏移比例。 ​
父节点:EraseRatioLocation​
TopLeftY​
Number​
0.6​
擦除框左上角 Y 轴偏移比例。 ​
父节点:EraseRatioLocation​
BottomRightX​
Number​
0.9​
擦除框右下角 X 轴偏移比例。 ​
父节点:EraseRatioLocation​
BottomRightY​
Number​
0.9​
擦除框右下角 Y 轴偏移比例。 ​
父节点:EraseRatioLocation​
EraseSubtitleResult​
-​
-​
字幕擦除任务中间或最终结果。​
TaskID​
String​
task-xxx​
底层处理任务 ID。 ​
父节点:EraseSubtitleResult​
TaskStatus​
String​
Success​
底层处理任务状态。 ​
父节点:EraseSubtitleResult​
VideoURL​
String​
https://example.com/output.mp4​
处理结果视频地址。 ​
父节点:EraseSubtitleResult​
​
任务类型为 Animation 时返回的额外元素​
​
名称​
参数类型​
示例值​
说明​
AnimationConfig​
-​
-​
视频转动图的具体配置。​
TimeInterval​
-​
-​
视频转动图的时间范围配置。​
父节点:AnimationConfig​
Start​
Integer​
0​
视频转动图的起始时间,单位为毫秒。取值:​
  • 0(默认值):从起始位置开始。​
  • 大于0:从第 ss 毫秒开始。​
父节点:TimeInterval​
Duration​
Integer​
0​
视频转动图的持续时间,单位为毫秒。取值:​
  • 0(默认值):到视频末尾。​
  • 大于0:起始时间后 ss 毫秒。​
父节点:TimeInterval​
Container​
-​
-​
视频转动图的输出容器格式。​
父节点:AnimationConfig​
Format​
String​
gif​
输出动图格式,取值:gif。​
父节点:Container​
Animation​
-​
-​
视频转动图的详细配置。​
父节点:AnimationConfig​
FrameNum​
Integer​
100​
动图帧数量,默认为不限制数量(抽帧到视频结束)。​
注意​
当视频长度不足时,实际抽帧数量会小于设定的参数值。​
父节点:Animation​
FrameInterval​
Integer​
1​
动图抽帧间隔,单位为毫秒,默认抽取所有视频帧。​
注意​
当该参数小于源视频帧间隔(帧率倒数)时,会按源视频帧间隔进行抽帧。​
父节点:Animation​
Fps​
Integer​
30​
动图帧率,默认为 inter 倒数。取值范围为 [0, 240]。​
说明​
该参数控制动图的播放速度,当为默认值时与源视频播放速度一致。比默认值大将产生加速效果,比默认值小将产生减速效果。​
父节点:Animation​
Width​
Integer​
1024​
输出动图的宽度,单位为 px,取值范围为 [32,4096]。​
说明​
如果指定为 0,则按源视频的分辨率比例自动计算。​
父节点:Animation​
Height​
Integer​
1024​
输出动图的高度,单位为 px,取值范围为 [32,4096]。​
说明​
如果指定为 0,则按源视频的分辨率比例自动计算。​
父节点:Animation​
ScaleType​
String​
crop​
缩放方式。取值:​
  • crop:缩放并裁剪。​
  • stretch(默认值):拉伸以填满。​
  • fill:缩放并保留黑边。​
  • fit:缩放并不保留黑边,等比缩放。​
父节点:Animation​
​
请求示例​
​
GET /?job_type=Segment&job_id=183535129563a53bfa710001887ae45ac629 HTTP/1.1​
Host: <bucket_name>.tos-cn-beijing.volces.com​
Date: Fri, 30 Jul 2021 08:05:36 +0000​
Authorization: <authorization_string>​
​
响应示例​
​
HTTP/1.1 200 OK​
Date: Fri, 30 Jul 2021 13:53:55 GMT​
Server: TosServer​
x-tos-id-2: 1e89f203jld00006-a444fd0​
x-tos-request-id: 1e89f203b2d00006-a444ed0​
​
{​
"JobID": "fa81ef2a00a2211f08a9aa5fa********",​
"CreateTime": "2025-11-18T20:32:54+08:00",​
"StartTime": "2025-11-18T20:32:55+08:00",​
"EndTime": "2025-11-18T20:32:55+08:00",​
"State": "Success",​
"Code": 0,​
"Message": "success",​
"Input" : { // 源文件​
"Object" : "sample.mp4" ​
},​
"RemuxConfig": {​
"Format": "mp4",​
"TranscodeIndex": 0,​
"StartTime": 1000,​
"EndTime": 20000,​
"Duration": 5,​
"AIGCMetadata": {​
"Label": "",​
"ContentProducer": "",​
"ProduceID": "",​
"ContentPropagator": "",​
"PropagateID": "",​
"ReservedCode1": "",​
"ReservedCode2": ""​
}​
},​
"Output" : { // 输出文件​
"Region" : "cn-beijing", ​
"Bucket" : "testbkt",​
"Object" : "output.mp4"​
}​
}​
​
​
最近更新时间:2026.08.03 15:17:34
这个页面对您有帮助吗?
有用
有用
无用
无用