调用SubmitAnalysisJob提交预置模板分析作业。
使用说明
- 通过本接口提交作业以后,媒体处理服务会对输入文件进行智能分析,推荐出适合输入文件的预置模板,可通过查询模板分析作业接口得到模板分析作业结果,也可使用异步通知机制。
- 预置模板分析的结果只保留半个月(从得到结果时算起),半个月后将被删除。如果半个月后再使用推荐的预置模板提交作业将返回转码作业失败,失败的错误码为:
AnalysisResultNotFound。
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | SubmitAnalysisJob | 操作接口名,系统规定参数,取值:SubmitAnalysisJob。 |
| Input | String | 是 | {"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example.flv"} | 作业输入,JSON对象。需在OSS控制台Bucket授权页面将Bucket读权限授权给媒体转码服务。更多信息请参见参数详情。 说明 OSS的地域需要与当前MPS所在地域保持一致。 |
| AnalysisConfig | String | 否 | {"QualityControl":{"RateQuality":25,"MethodStreaming":"network"}} | 模板分析作业配置,根据您的实际需要按需设置。更多参数信息请参见参数详情。 |
| UserData | String | 否 | testid-001 | 用户自定义数据,可以使用中英文、数字、中划线(-)等,不能以特殊字符开头,最大长度1024个字节。 |
| PipelineId | String | 是 | bb558c1cc25b45309aab5be44d19**** | 管道ID,可以通过MPS控制台>全局设置>管道查看。如果需要异步通知,须保证此管道绑定了可用的消息主题。 |
| Priority | String | 否 | 10 | 任务在其对应管道内的转码优先级。
|
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | B52658D4-07AB-43CD-82B0-210958A65E23 | 请求ID。 |
| AnalysisJob | Object | 系统预置模板分析作业。 |
|
| CreationTime | String | 2014-01-10T12:00:00Z | 作业添加时间。 |
| Percent | Long | 100 | 转码进度。 |
| State | String | Success | 作业状态。
|
| AnalysisConfig | Object | 作业配置。 |
|
| QualityControl | Object | 输出质量控制。 |
|
| MethodStreaming | String | network | 播放方式。
|
| RateQuality | String | 50 | 输出质量等级。 |
| PropertiesControl | Object | 属性控制。 |
|
| Deinterlace | String | Force | 强制扫描模式判定。
|
| Crop | Object | 视频裁切配置。 |
|
| Top | String | 8 | 裁切上边距。 说明 若Mode为Auto或None,则此值失效。 |
| Width | String | 8 | 裁切后宽。 说明 若Mode为Auto或None,则此值失效。 |
| Height | String | 8 | 裁切后高。 说明 若Mode为Auto或None,则此值失效。 |
| Left | String | 8 | 裁切左边距。 说明 若Mode为Auto或None,则此值失效。 |
| Mode | String | Auto | 裁切方式。取值:
|
| Message | String | The resource operated \"PipelineId\" cannot be found | 分析失败时错误信息。 |
| Priority | String | 10 | 任务在其对应管道内的优先级。
|
| MNSMessageResult | Object | MNS通知用户作业完成的结果。 |
|
| MessageId | String | 3ca84a39a9024f19853b21be9cf9**** | 成功时消息ID。分析失败时不返回此参数。 |
| ErrorMessage | String | The resource operated \"PipelineId\" cannot be found | 失败时错误信息。分析成功时不返回此参数。 |
| ErrorCode | String | InvalidParameter.ResourceNotFound | 失败时错误码。分析成功时不返回此参数。 |
| TemplateList | Array of Template | 作业输出的预置模板列表。 |
|
| Template | |||
| Video | Object | 视频编解码配置。 |
|
| Bufsize | String | 5000 | 缓冲区大小。
|
| Degrain | String | 5 | 独立去噪算法强度。 |
| BitrateBnd | Object | 视频平均码率范围。 |
|
| Max | String | 20 | 总码率上限。单位:Kbps。 |
| Min | String | 10 | 总码率下限。单位:Kbps。 |
| PixFmt | String | yuvj420p | 视频颜色格式。包含yuv420p,yuvj420p等标准颜色格式。 |
| Codec | String | H.264 | 编解码格式。默认值:H.264。 |
| Height | String | 1880 | 视频高。
|
| Qscale | String | 15 | 视频质量控制度。 |
| Bitrate | String | 10 | 视频平均码率。单位:Kbps。 |
| Maxrate | String | 10 | 视频码率峰值。单位:Kbps。 |
| Profile | String | baseline | 编码级别。
|
| Crf | String | 27 | 码率-质量控制因子。
|
| Gop | String | 1 | 关键帧间最大帧数。默认值:250。 |
| Width | String | 1990 | 视频宽。
|
| Fps | String | 60 | 帧率。
|
| Preset | String | medium | 视频算法器预置。支持veryfast(超快)、fast(快)、medium(中等)、slow(慢)、slower(超慢)。默认值:medium。 |
| ScanMode | String | progressive | 扫描模式。取值:
|
| TransConfig | Object | 转码通用配置。 |
|
| TransMode | String | onepass | 转码模式。取值:onepass、twopass、CBR。默认值:onepass。 |
| State | String | Normal | 模板的状态。
|
| MuxConfig | Object | 转码封包配置。 |
|
| Gif | Object | gif格式。 |
|
| FinalDelay | String | 0 | gif的loop间隔,单位为百分之一秒,比如500代表间隔为5秒。 |
| Loop | String | 0 | gif与webp循环次数,默认不循环。 |
| Segment | Object | 切片配置。 |
|
| Duration | String | 60 | 分片时长。单位:秒。 |
| Name | String | FLV-UD | 模板名称。 |
| Audio | Object | 音频编解码配置。 |
|
| Profile | String | aac_low | 音频编码预置。当Codec为aac时可取值:aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。 |
| Codec | String | mp3 | 音频编解码格式。默认值:aac。 |
| Samplerate | String | 32000 | 采样率。
|
| Qscale | String | 10 | 音频质量控制度。 |
| Channels | String | 1 | 声道数。默认值:2。 |
| Bitrate | String | 8 | 输出文件的音频码率。
|
| Id | String | S00000000-00**** | 转码模板ID。 |
| Container | Object | 容器。 |
|
| Format | String | flv | 容器格式。 |
| UserData | String | testid-001 | 用户自定义数据。 |
| Code | String | InvalidParameter.ResourceNotFound | 分析失败时错误码。分析成功时不返回此参数。 |
| InputFile | Object | 作业输入。 |
|
| Object | String | example.flv | OSS的Object。 |
| Location | String | oss-cn-hangzhou | OSS的服务区域。 |
| Bucket | String | example-bucket | OSS的Bucket。 |
| PipelineId | String | bb558c1cc25b45309aab5be44d19**** | 管道ID。 |
| Id | String | 57f6aa3f84824309bcba67231b40**** | 模板分析作业ID。 |
示例
请求示例
http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=SubmitAnalysisJob
&Input={"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example.flv"}
&AnalysisConfig={"QualityControl":{"RateQuality":25,"MethodStreaming":"network"}}
&UserData=testid-001
&PipelineId=bb558c1cc25b45309aab5be44d19****
&Priority=10
&<公共请求参数>
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<SubmitAnalysisJobResponse>
<RequestId>B52658D4-07AB-43CD-82B0-210958A65E23</RequestId>
<AnalysisJob>
<CreationTime>2014-01-10T12:00:00Z</CreationTime>
<Percent>100</Percent>
<State>Success</State>
<AnalysisConfig>
<QualityControl>
<MethodStreaming>network</MethodStreaming>
<RateQuality>50</RateQuality>
</QualityControl>
<PropertiesControl>
<Deinterlace>Force</Deinterlace>
<Crop>
<Top>8</Top>
<Width>8</Width>
<Height>8</Height>
<Left>8</Left>
<Mode>Auto</Mode>
</Crop>
</PropertiesControl>
</AnalysisConfig>
<Message>The resource operated \"PipelineId\" cannot be found</Message>
<Priority>10</Priority>
<MNSMessageResult>
<MessageId>3ca84a39a9024f19853b21be9cf9****</MessageId>
</MNSMessageResult>
<TemplateList>
<Video>
<Bufsize>5000</Bufsize>
<Degrain>5</Degrain>
<BitrateBnd>
<Max>20</Max>
<Min>10</Min>
</BitrateBnd>
<PixFmt>yuvj420p</PixFmt>
<Codec>H.264</Codec>
<Height>1880</Height>
<Qscale>15</Qscale>
<Bitrate>10</Bitrate>
<Maxrate>10</Maxrate>
<Profile>baseline</Profile>
<Crf>27</Crf>
<Gop>1</Gop>
<Width>1990</Width>
<Fps>60</Fps>
<Preset>medium</Preset>
<ScanMode>progressive</ScanMode>
</Video>
<TransConfig>
<TransMode>onepass</TransMode>
</TransConfig>
<State>Normal</State>
<MuxConfig>
<Gif>
<FinalDelay>0</FinalDelay>
<Loop>0</Loop>
</Gif>
<Segment>
<Duration>60</Duration>
</Segment>
</MuxConfig>
<Name>FLV-UD</Name>
<Audio>
<Profile>aac_low</Profile>
<Codec>mp3</Codec>
<Samplerate>32000</Samplerate>
<Qscale>10</Qscale>
<Channels>1</Channels>
<Bitrate>8</Bitrate>
</Audio>
<Id>S00000000-00****</Id>
<Container>
<Format>flv</Format>
</Container>
</TemplateList>
<UserData>testid-001</UserData>
<InputFile>
<Object>example.flv</Object>
<Location>oss-cn-hangzhou</Location>
<Bucket>example-bucket</Bucket>
</InputFile>
<PipelineId>bb558c1cc25b45309aab5be44d19****</PipelineId>
<Id>57f6aa3f84824309bcba67231b40****</Id>
</AnalysisJob>
</SubmitAnalysisJobResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId": "B52658D4-07AB-43CD-82B0-210958A65E23",
"AnalysisJob": {
"CreationTime": "2014-01-10T12:00:00Z",
"Percent": 100,
"State": "Success",
"AnalysisConfig": {
"QualityControl": {
"MethodStreaming": "network",
"RateQuality": "50"
},
"PropertiesControl": {
"Deinterlace": "Force",
"Crop": {
"Top": "8",
"Width": "8",
"Height": "8",
"Left": "8",
"Mode": "Auto"
}
}
},
"Message": "The resource operated \\\"PipelineId\\\" cannot be found",
"Priority": "10",
"MNSMessageResult": {
"MessageId": "3ca84a39a9024f19853b21be9cf9****",
},
"TemplateList": [
{
"Video": {
"Bufsize": "5000",
"Degrain": "5",
"BitrateBnd": {
"Max": "20",
"Min": "10"
},
"PixFmt": "yuvj420p",
"Codec": "H.264",
"Height": "1880",
"Qscale": "15",
"Bitrate": "10",
"Maxrate": "10",
"Profile": "baseline",
"Crf": "27",
"Gop": "1",
"Width": "1990",
"Fps": "60",
"Preset": "medium",
"ScanMode": "progressive"
},
"TransConfig": {
"TransMode": "onepass"
},
"State": "Normal",
"MuxConfig": {
"Gif": {
"FinalDelay": "0",
"Loop": "0"
},
"Segment": {
"Duration": "60"
}
},
"Name": "FLV-UD",
"Audio": {
"Profile": "aac_low",
"Codec": "mp3",
"Samplerate": "32000",
"Qscale": "10",
"Channels": "1",
"Bitrate": "8"
},
"Id": "S00000000-00****",
"Container": {
"Format": "flv"
}
}
],
"UserData": "testid-001",
"InputFile": {
"Object": "example.flv",
"Location": "oss-cn-hangzhou",
"Bucket": "example-bucket"
},
"PipelineId": "bb558c1cc25b45309aab5be44d19****",
"Id": "57f6aa3f84824309bcba67231b40****"
}
}
错误码
访问错误中心查看更多错误码。