调用SubmitVideoQualityJob提交视频质量审核作业。

使用说明

  • 本接口目前支持的地域为华东2(上海)。
  • 本接口提交的作业是异步执行方式,作业添加到管道中调度排队和执行。可以通过查询视频质量审核作业查询作业执行情况,也可以使用异步的消息通知机制。

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SubmitVideoQualityJob

系统规定参数,取值:SubmitVideoQualityJob

UserId Long 174809843091****

用户ID。可以通过MPS控制台顶部导航栏左侧单击头像查看。

PipelineId String 50842ce19a684a189625e9ab777f****

管道ID,可以通过MPS控制台 > 全局设置 > 管道获取。用于确认作业回调队列以及提供租户隔离能力。如果不传,则使用默认管道,默认作业并发数2,不绑定消息通知。

SourceType String Video

文件类型。取值:Video

ModelId String null

算法模型ID。如果为空,则选择对应功能的默认模型(此参数保持为空即可,一般无需传入,直接使用默认模型)。

Input String oss://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example.mp4

输入文件的OSS Bucket,目前只支持OSS路径传入。可以通过OSS控制台 > 我的访问路径获取。

Output String oss://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example1.txt

输出文件的OSS Bucket,用户自定义,目前只支持OSS路径。可以通过OSS控制台 > 我的访问路径获取。

JobParams String 0

算法作业参数。

ScheduleParams String 0

作业调度参数,设置任务调度配置(非必填,保持为空即可)。

UserData String example data

通过MNS回调时传回来的信息,支持中英文、数字等,大小不能超过1KB。

NotifyUrl String mns://142610549622****.mns.cn-shanghai.aliyuncs.com/queues/quequ-****

Callback路径,目前只支持MNS队列。可以通过MNS控制台 > 队列列表 > 详情获取。

返回数据

名称 类型 示例值 描述
Message String The job is completed successfully

作业信息。

RequestId String 5210DBB0-E327-4D45-ADBC-0B83C8796E26

请求ID。

Code String Success

错误码。请求成功时返回"Success"。

JobId String 0c8f04aa60bd4377a906bd6c91ec****

作业ID。建议您保存此ID便于后续调用其他接口时使用。

示例

请求示例

http(s)://mts.cn-shanghai.aliyuncs.com/?Action=SubmitVideoQualityJob
&PipelineId=50842ce19a684a189625e9ab777f****
&SourceType=Video
&ModelId=null
&Input=oss://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example.mp4
&Output=oss://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example1.txt
&JobParams=0
&ScheduleParams=0
&UserData=example data
&NotifyUrl=mns://142610549622****.mns.cn-shanghai.aliyuncs.com/queues/quequ-****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SubmitVideoQualityJobResponse>
    <Message>The job is completed successfully</Message>
    <RequestId>5210DBB0-E327-4D45-ADBC-0B83C8796E26</RequestId>
    <Code>Success</Code>
    <JobId>0c8f04aa60bd4377a906bd6c91ec****</JobId>
</SubmitVideoQualityJobResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "The job is completed successfully",
  "RequestId" : "5210DBB0-E327-4D45-ADBC-0B83C8796E26",
  "Code" : "Success",
  "JobId" : "0c8f04aa60bd4377a906bd6c91ec****"
}

错误码

访问错误中心查看更多错误码。