QueryFpShotJobList - 查询DNA作业结果

更新时间:
复制为 MD 格式

查询DNA作业结果,本接口支持查询所有类型的DNA作业结果。

接口说明

  • 提交 DNA 作业后,DNA 服务会进行 DNA 对比,通过本接口可以查询作业结果。

  • 查询文本 DNA 作业目前仅支持华东 2(上海)地域使用。

  • 本接口只支持查询六个月以内的 DNA 任务信息。

QPS 限制

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mts:QueryFpShotJobList

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

JobIds

string

需要查询的 DNA 作业 ID 列表。一次最多建议查询 10 个,用半角逗号(,)分隔。

88c6ca184c0e47098a5b665e2a12****

NextPageToken

string

下一页标识。第一次请求无需传入,服务会返回,第二次请求传入即可。

16f01ad6175e4230ac42bb5182cd****

MaximumPageSize

integer

每页最大返回数。

  • 默认:10

  • 取值:1~30

10

State

string

需要查询的作业状态。取值:

  • All:全部。

  • Queuing:排队中。

  • Analysing:分析中。

  • Fail:失败。

  • Success:成功。

All

StartOfJobCreatedTimeRange

string

最早任务创建时间。

  • 日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。

  • 格式为:YYYY-MM-DDThh:mm:ssZ 。

2021-12-22T03:48:05Z

EndOfJobCreatedTimeRange

string

最晚任务创建时间。

  • 日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。

  • 格式为:YYYY-MM-DDThh:mm:ssZ 。

2022-02-14T02:16:07Z

PipelineId

string

管道 ID。可以通过媒体处理控制台 > 全局设置 > 管道及回调获取。

b11c171cced04565b1f38f1ecc39****

返回参数

名称

类型

描述

示例值

object

返回参数。

RequestId

string

请求 ID。

25818875-5F78-4A13-BEF6-D7393642CA58

NextPageToken

string

下一页标识。需记录下来,在下一次请求时传入即可。

b11c171cced04565b1f38f1ecc39****

FpShotJobList

object

FpShotJob

array<object>

DNA 作业信息。

array<object>

DNA 作业信息详情。

FpShotResult

object

DNA 作业查询结果。

AudioFpShots

object

FpShot

array<object>

音频 DNA 查询结果。

array<object>

音频 DNA 查询结果详细信息。

PrimaryKey

string

唯一主键。

498ac941373341599c4777c8d884****

FpShotSlices

object

FpShotSlice

array<object>

相似音频。

array<object>

相似音频详细信息。

Duplication

object

DNA 库中音频的开始时间和时长。

Start

string

开始时间。

0

Duration

string

时长。

3

Similarity

string

音频片段相似度。

0

Input

object

输入音频的开始时间和时长。

Start

string

开始时间。

0

Duration

string

时长。

5

Similarity

string

音频整体相似度。

0

FpShots

object

FpShot

array<object>

视频 DNA 查询结果。

array<object>

视频 DNA 查询结果详细信息。

PrimaryKey

string

视频唯一主键。

498ac941373341599c4777c8d884****

FpShotSlices

object

FpShotSlice

array<object>

相似视频。

array<object>

相似视频详情。

Duplication

object

DNA 库中视频的开始时间和时长。

Start

string

开始时间。

1260

Duration

string

时长。

48

Similarity

string

视频片段相似度。

0

Input

object

输入视频的开始时间和时长。

Start

string

开始时间。

46

Duration

string

时长。

48

Similarity

string

视频整体相似度。

说明

整体相似度是片段相似度的平均值。如果 DNA 库中存在多个相似段,会返回多个命中结果。

0.8914769887924194

TextFpShots

object

TextFpShot

array<object>

文本 DNA 查询结果。

array<object>

文本 DNA 查询结果详细信息。

PrimaryKey

string

文本唯一主键。

3e34ac649945b53a1b0f863ce030****

Similarity

string

文本相似度。

1.0

TextFpShotSlices

object

TextFpShotSlice

array<object>

重复文本。

array<object>

重复文本详细信息。

Similarity

string

匹配片段的置信度。

1.0

InputText

string

查询匹配的文本片段。

今天下雪了

DuplicationText

string

底库匹配的文本片段。

今天下雪了

InputFragment

object

查询匹配片段起始时间和时长。

Start

string

起始时间。

0

Duration

string

时长。

3

CreationTime

string

创建时间。

2017-01-10T12:00:00Z

FinishTime

string

完成时间。

0

State

string

作业状态,可取值:

  • Queuing:排队中。

  • Analysing:分析中。

  • Success:成功。

  • Fail:失败。

Success

Message

string

分析失败时错误信息。如果执行成功则不返回此参数。

The parameter \"Id\" is invalid.A uuid must:1)be comprised of chracters[a-f],numbers[0-9];2)be 32 characters long

FpShotConfig

object

配置。

PrimaryKey

string

唯一的视频主键,唯一性由用户保证。

3ca84a39a9024f19853b21be9cf9****

SaveType

string

存储类型,取值:

  • nosave:不入库。

  • save:去重入库。

  • forcesave:强制入库。

save

FpDBId

string

DNA 库 ID。

2288c6ca184c0e47098a5b665e2a12****

FileId

string

文件 ID。

ebb51ee30f0b49aba959823fa991****

UserData

string

用户自定义数据。

testid-001

Duration

integer

输入文件时长,单位秒。

5

Code

string

分析失败时错误码。

InvalidParameter.UUIDFormatInvalid

InputFile

object

作业输入。

Object

string

作业输入所在的 OSS Object。

test.mp4

Location

string

作业输入所在的 OSS Location。

oss-cn-beiing

Bucket

string

作业输入所在的 OSS Bucket。

oss-test

PipelineId

string

管道 ID。

88c6ca184c0e47098a5b665e2a12****

Id

string

作业 ID。

88c6ca184c0e47098a5b665e2a12****

Input

string

作业输入。

{"Bucket":"oss-test","Location":"oss-cn-beiing","Object":"test.mp4"}

NonExistIds

object

String

array

不存在的作业 ID 列表。

string

不存在的作业 ID 列表,无数据时该参数不返回。

ae687c02fe944327ba9631e50da23128****

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  "NextPageToken": "b11c171cced04565b1f38f1ecc39****",
  "FpShotJobList": {
    "FpShotJob": [
      {
        "FpShotResult": {
          "AudioFpShots": {
            "FpShot": [
              {
                "PrimaryKey": "498ac941373341599c4777c8d884****",
                "FpShotSlices": {
                  "FpShotSlice": [
                    {
                      "Duplication": {
                        "Start": "0",
                        "Duration": "3"
                      },
                      "Similarity": "0",
                      "Input": {
                        "Start": "0",
                        "Duration": "5"
                      }
                    }
                  ]
                },
                "Similarity": "0"
              }
            ]
          },
          "FpShots": {
            "FpShot": [
              {
                "PrimaryKey": "498ac941373341599c4777c8d884****",
                "FpShotSlices": {
                  "FpShotSlice": [
                    {
                      "Duplication": {
                        "Start": "1260",
                        "Duration": "48"
                      },
                      "Similarity": "0",
                      "Input": {
                        "Start": "46",
                        "Duration": "48"
                      }
                    }
                  ]
                },
                "Similarity": "0.8914769887924194"
              }
            ]
          },
          "TextFpShots": {
            "TextFpShot": [
              {
                "PrimaryKey": "3e34ac649945b53a1b0f863ce030****",
                "Similarity": "1.0",
                "TextFpShotSlices": {
                  "TextFpShotSlice": [
                    {
                      "Similarity": "1.0",
                      "InputText": "今天下雪了",
                      "DuplicationText": "今天下雪了",
                      "InputFragment": {
                        "Start": "0",
                        "Duration": "3"
                      }
                    }
                  ]
                }
              }
            ]
          }
        },
        "CreationTime": "2017-01-10T12:00:00Z",
        "FinishTime": "0",
        "State": "Success",
        "Message": "The parameter \\\"Id\\\" is invalid.A uuid must:1)be comprised of chracters[a-f],numbers[0-9];2)be 32 characters long",
        "FpShotConfig": {
          "PrimaryKey": "3ca84a39a9024f19853b21be9cf9****",
          "SaveType": "save",
          "FpDBId": "2288c6ca184c0e47098a5b665e2a12****"
        },
        "FileId": "ebb51ee30f0b49aba959823fa991****",
        "UserData": "testid-001",
        "Duration": 5,
        "Code": "InvalidParameter.UUIDFormatInvalid",
        "InputFile": {
          "Object": "test.mp4",
          "Location": "oss-cn-beiing",
          "Bucket": "oss-test"
        },
        "PipelineId": "88c6ca184c0e47098a5b665e2a12****",
        "Id": "88c6ca184c0e47098a5b665e2a12****",
        "Input": "{\"Bucket\":\"oss-test\",\"Location\":\"oss-cn-beiing\",\"Object\":\"test.mp4\"}"
      }
    ]
  },
  "NonExistIds": {
    "String": [
      "ae687c02fe944327ba9631e50da23128****"
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情