开发者指南

API 文档

SDK 文档

提交视频审核任务

最近更新时间:2020-08-11 15:57:35

功能描述

CreateVideoAuditingJob 接口用于提交一个视频审核任务。您可以通过主动设置回调地址接收审核信息,也可以通过 Jobid 进行查询。

请求

请求示例

POST /video/auditing HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml

<body>
说明:

  • 此接口 Host 需要填写数据万象域名。
  • Authorization: Auth String (详情请参见 请求签名 文档)。

请求头

此接口仅使用数据万象的公共请求头部,详情请参见数据万象 公共请求头部 文档。

请求体

该请求操作的实现需要有如下请求体。

<Request>
  <Input>
    <Object></Object>
  </Input>
  <Conf>
    <DetectType>Porn,Terrorism,Politics,Ads</DetectType>
    <Snapshot>
        <Mode>Interval</Mode>
        <TimeInterval></TimeInterval>
        <Count></Count>
    </Snapshot>
    <Callback></Callback>
  </Conf>
</Request>

具体的数据描述如下:

节点名称(关键字) 父节点 描述 类型 是否必选
Request 保存请求的容器 Container

Container 类型 Request 的具体数据描述如下:

节点名称(关键字) 父节点 描述 类型 是否必选
Input Request 待操作的媒体信息 Container
Conf Request 操作规则 Container

Container 类型 Input 的具体数据描述如下:

节点名称(关键字) 父节点 描述 类型 是否必选
Object Request.Input 媒体文件的名称 String

Container 类型 Conf 的具体数据描述如下:

节点名称(关键字) 父节点 描述 类型 是否必选
DetectType Request.Conf 审核类型 涉黄 Porn、涉暴恐 Terrorism、政治敏感 Politics、广告 Ads,可以审核多种类型 string
Snapshot Request.Conf 截帧配置 Container
Callback Request.Conf 回调地址,以http://或者https://开头的地址 string

Container 类型 Snapshot 的具体数据描述如下:

节点名称(关键字) 父节点 描述 类型 是否必选
Mode Request.Conf.Snapshot 截帧模式。Interval 表示间隔模式;Average 表示平均模式;Fps 表示固定帧率模式。
  • Interval 模式:TimeInterval,Count 参数生效。当设置 Count,未设置 TimeInterval 时,表示截取所有帧,共 Count 张图片
  • Average 模式:Count 参数生效。表示整个视频,按平均间隔截取共 Count 张图片
  • Fps 模式:TimeInterval 表示每秒截取多少帧,Count 表示共截取多少帧
  • Container
    Count Request.Conf.Snapshot 截图数量,范围为(0 10000] string
    TimeInterval Request.Conf.Snapshot 截图频率,范围为(0 60],单位为秒,支持 float 格式,执行精度精确到毫秒 string

    响应

    响应头

    此接口仅返回数据万象的公共响应头部,详情请参见数据万象 公共响应头部 文档。

    响应体

    该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:

    <Response>
      <JobsDetail>
        <JobId></JobId>
        <State></State>
        <CreationTime></CreationTime>
      </JobsDetail>
    </Response>

    具体的数据内容如下:

    节点名称(关键字) 父节点 描述 类型
    Response 保存结果的容器 Container

    Container 节点 Response 的内容:

    节点名称(关键字) 父节点 描述 类型
    JobsDetail Response 任务的详细信息 Container

    Container 节点 JobsDetail 的内容:

    节点名称(关键字) 父节点 描述 类型
    JobId Response.JobsDetail 新创建任务的 ID String
    State Response.JobsDetail 任务的状态,为 Submitted、Snapshoting、Success、Failed、Auditing 其中一个 String
    CreationTime Response.JobsDetail 任务的创建时间 String

    错误码

    此接口遵循统一的错误响应和错误码,详情请参见数据万象 错误码 文档。

    实际案例

    请求

    POST /auditing HTTP/1.1
    Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
    Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
    Content-Length: 166
    Content-Type: application/xml
    
    <Request>
      <Input>
        <Object>a.mp4</Object>
      </Input>
      <Conf>
        <DetectType>Porn,Terrorism,Politics,Ads</DetectType>
        <Snapshot>
            <Mode>Interval</Mode>
            <Start>0.5</Start>
            <TimeInterval>100.5</TimeInterval>
            <Count>100</Count>
        </Snapshot>
        <Callback>http://callback.com/</Callback>
      </Conf>
    </Request>

    响应

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 230
    Connection: keep-alive
    Date: Thu, 15 Jun 2017 12:37:29 GMT
    Server: tencent-ci
    x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
    
    <Response>
      <JobsDetail>
        <JobId>vab1ca9fc8a3ed11ea834c525400863904</JobId>
        <State>Submitted</State>
        <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
      </JobsDetail>
    </Response>
    目录