SubmitFpShotJob - 提交DNA作业

查询DNA底库中是否存在相同或者相近的DNA结果。

接口说明

  • 本接口可以提交视频、音频、图片和文本 DNA 作业。
  • 本接口为异步接口。不保证接口返回时结果已经生成,结果完成后将发送异步消息。
  • DNA 相关接口功能,目前开通的地域为华北 2(北京)、华东 2(上海)、华东 1(杭州)、亚太东南 1(新加坡)、沙特(利雅得),其他地域暂不支持。其中,文本 DNA 相关功能,目前仅支持华东 2(上海)地域使用。
  • 输入文件格式限制如下:
    • 图片格式:jpeg、png、bmp。
    • 视频格式:mp4、avi、mkv、mpg、ts、mov、flv、mxf。
    • 视频编码:MPEG2、MPEG4、H264、HEVC、WMV。
  • 文本 DNA 使用场景:底库仅支持入库 TextType=Text 的长文本字符串,搜索指定 TextType=ASR 的输入是 ASR 识别结果,包含 start、end、text 的 JSON 字符串数组。

QPS 限制

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mts:SubmitFpShotJob
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Inputstring

作业输入文件地址,支持 OSS 地址、HTTP 地址、视频点播(VoD)媒资等形式。

  • OSS 地址:OSS 三元组,JSONString。例如:{"Bucket":"test-bucket","Location":"oss-cn-shanghai","Object":"test.mp4"}

  • HTTP 地址:公网可下载的地址。例如:http://example-test-****.mp4。

  • 视频点播(VOD)媒资地址:媒资 Id,JSONString。例如:{"MediaId":"99238***321"}

说明 OSS 的地域和媒资存储地域需要与当前 MPS 所在地域保持一致。
{"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.flv"}
PipelineIdstring

管道 ID,用于绑定消息通知。可通过媒体处理控制台>全局设置>管道获取。

88c6ca184c0e47098a5b665e2a12****
FpShotConfigstring

视频 DNA 配置,JSON 对象。更多信息,请参见 FpShotConfig 详情

{ "PrimaryKey": "12345****", "SaveType": "save", "FpDBId": "417f2ada5999daf****" }
UserDatastring

用户自定义数据,最大长度 128 个字节,不能以特殊字符开头。

testid-****

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

25818875-5F78-4A13-BEF6-D7393642CA58
JobIdstring

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

2a0697e35a7342859f733a9190c4****

异步通知消息参数

名称类型描述
TypeString消息类型。
FpShotJobNotifyAliyunFpShotJobNotify视频 DNA 作业,参见数据类型 AliyunFpShotJobNotify
UserDataString用户自定义数据。

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  "JobId": "2a0697e35a7342859f733a9190c4****"
}

错误码

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