Queries the results of all types of media fingerprint analysis jobs.

Usage notes

  • After a media fingerprint analysis job is submitted, the media fingerprint service compares the fingerprints of the job input with those of the media files in the media fingerprint library. You can call this operation to query the job results.
  • You can query the results of a text fingerprint analysis job only in the China (Shanghai) region.

QPS limit

You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limit.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes QueryFpShotJobList

The operation that you want to perform. Set the value to QueryFpShotJobList.

JobIds String No 88c6ca184c0e47098a5b665e2a12****

The IDs of the media fingerprint analysis jobs that you want to query. To view the job IDs, log on to the ApsaraVideo Media Processing (MPS) console (https://mps.console.alibabacloud.com/overview), click Tasks in the left-side navigation pane, and then click the Video DNA tab on the Tasks page. You can query up to 10 media fingerprint analysis jobs at a time. Separate multiple job IDs with commas (,).

NextPageToken String No 16f01ad6175e4230ac42bb5182cd****

The token that is used to retrieve the next page of the query results. You do not need to specify this parameter in the first request. The response to the first request contains this parameter, which you add to the next request.

MaximumPageSize Long No 10

The maximum number of entries to return on each page.

  • Default value: 10.
  • Valid values: 1 to 100.
State String No All

The status of the jobs to be queried. Valid values:

  • All: specifies to query jobs of all statuses.
  • Queuing: The job is waiting in the queue.
  • Analysing: The job is in progress.
  • Fail: The job fails.
  • Success: The job is successful.
StartOfJobCreatedTimeRange String No 2021-12-22T03:48:05Z

The beginning of the time range within which the jobs to be queried were created.

  • Specify the time in the ISO 8601 standard and in UTC format.
  • Format: YYYY-MM-DDThh:mm:ssZ.
EndOfJobCreatedTimeRange String No 2022-02-14T02:16:07Z

The end of the time range within which the jobs to be queried were created.

  • Specify the time in the ISO 8601 standard and in UTC format.
  • Format: YYYY-MM-DDThh:mm:ssZ.
PipelineId String No b11c171cced04565b1f38f1ecc39****

The ID of the MPS queue to which the analysis job is submitted. To view the ID of the MPS queue, you can log on to the MPS console and choose Global Settings > Pipelines in the left-side navigation pane.

Response parameters

Parameter Type Example Description
RequestId String 25818875-5F78-4A13-BEF6-D7393642CA58

The ID of the request.

NextPageToken String b11c171cced04565b1f38f1ecc39****

The token that is used to retrieve the next page of the query results. You must record the token and specify it in the next request.

FpShotJobList Array of FpShotJob

The array of media fingerprint analysis jobs.

FpShotJob
FpShotResult Object

The results of media fingerprint analysis jobs.

AudioFpShots Array of FpShot

The audio fingerprint analysis results.

FpShot
PrimaryKey String 498ac941373341599c4777c8d884****

The unique primary key of the input audio.

FpShotSlices Array of FpShotSlice

The array of audio files that have similar fingerprints to the input audio in the audio fingerprint library.

FpShotSlice
Duplication Object

The start point in time and length of the similar audio clip in the audio file that has similar fingerprints to the input audio in the audio fingerprint library.

Start String 0

The start point in time.

Duration String 3

The length.

Similarity String 0

The similarity of the input audio against the audio file that has similar fingerprints to the input audio in the audio fingerprint library.

Input Object

The start point in time and length of the similar audio clip in the input audio.

Start String 0

The start point in time.

Duration String 5

The length.

Similarity String 0

The overall similarity of the input audio against audio files that have similar fingerprints to the input audio in the audio fingerprint library.

FpShots Array of FpShot

The video fingerprint analysis results.

FpShot
PrimaryKey String 498ac941373341599c4777c8d884****

The unique primary key of the input video.

FpShotSlices Array of FpShotSlice

The array of videos that have similar fingerprints to the input video in the video fingerprint library.

FpShotSlice
Duplication Object

The start point in time and length of the similar video clip in the video that has similar fingerprints to the input video in the video fingerprint library.

Start String 1260

The start point in time.

Duration String 48

The length.

Similarity String 0

The similarity of the input video clip against the video that has similar fingerprints to the input video in the video fingerprint library.

Input Object

The start point in time and length of the similar video clip in the input video.

Start String 46

The start point in time.

Duration String 48

The length.

Similarity String 0.8914769887924194

The overall similarity of the input video against videos that have similar fingerprints to the input video in the video fingerprint library.

Note The overall similarity is the average value of the similarities of the input video against all similar video clips. If multiple similar video clips exist in the video fingerprint library, the similarities of the input video against multiple similar video clips are returned.
TextFpShots Array of TextFpShot

The text fingerprint analysis results.

TextFpShot
PrimaryKey String 3e34ac649945b53a1b0f863ce030****

The unique primary key of the input text.

Similarity String 1.0

The similarity of the input text against text snippets that have similar fingerprints to the input text in the text fingerprint library.

TextFpShotSlices Array of TextFpShotSlice

The array of text snippets that have similar fingerprints to the input text in the text fingerprint library.

TextFpShotSlice
Similarity String 1.0

The similarity of the input text against the text snippet that has similar fingerprints to the input text in the text fingerprint library.

InputText String It's snowy today.

The input text for text fingerprint analysis.

DuplicationText String It's snowy today.

The text snippet that has similar fingerprints to the input text in the text fingerprint library.

InputFragment Object

The start point in time and length of the similar text snippet in the input text.

Start String 0

The start point in time.

Duration String 3

The length.

CreationTime String 2017-01-10T12:00:00Z

The point in time when the job was created.

FinishTime String 0

The point in time when the job was complete.

State String Success

The status of the job. Valid values:

  • Queuing: The job is waiting in the queue.
  • Analysing: The job is in progress.
  • Success: The job is successful.
  • Fail: The job fails.
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

The error message returned when the job fails. This parameter is not returned if the job is successful.

FpShotConfig Object

The configurations of the job.

PrimaryKey String 3ca84a39a9024f19853b21be9cf9****

The unique primary key of the input video.

SaveType String save

The storage type. Valid values:

  • nosave: The fingerprints of the job input are not saved to the media fingerprint library.
  • save: The fingerprints of the job input are saved to the media fingerprint library only if the job input is not duplicated with media content in the media fingerprint library.
  • forcesave: The fingerprints of the job input are forcibly saved to the media fingerprint library.
FpDBId String 2288c6ca184c0e47098a5b665e2a12****

The ID of the media fingerprint library.

FileId String ebb51ee30f0b49aba959823fa991****

The ID of the matched file in the media fingerprint library.

UserData String testid-001

The custom data.

Code String InvalidParameter.UUIDFormatInvalid

The error code returned when the job fails.

InputFile Object

The information about the job input.

Object String test.mp4

The Object Storage Service (OSS) object that is used as the job input.

Location String oss-cn-beiing

The OSS region in which the job input resides.

Bucket String oss-test

The OSS bucket in which the job input resides.

PipelineId String 88c6ca184c0e47098a5b665e2a12****

The ID of the MPS queue to which the analysis job is submitted.

Id String 88c6ca184c0e47098a5b665e2a12****

The ID of the job.

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

The information about the job input.

NonExistIds Array of String ae687c02fe944327ba9631e50da23128****

The job IDs that do not exist. This parameter is not returned if all specified jobs are found.

Examples

Sample requests

http(s)://mts.cn-shanghai.aliyuncs.com/?Action=QueryFpShotJobList
&JobIds=88c6ca184c0e47098a5b665e2a12****
&<Common request parameters>

Sample success responses

XML format

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

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

JSON format

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

{
  "RequestId" : "25818875-5F78-4A13-BEF6-D7393642CA58",
  "FpShotJobList" : [ {
    "FpShotResult" : {
      "AudioFpShots" : [ {
        "PrimaryKey" : "498ac941373341599c4777c8d884****",
        "FpShotSlices" : [ {
          "Duplication" : {
            "Start" : "0",
            "Duration" : "3"
          },
          "Similarity" : "0",
          "Input" : {
            "Start" : "0",
            "Duration" : "5"
          }
        } ],
        "Similarity" : "0"
      } ],
      "FpShots" : [ {
        "PrimaryKey" : "498ac941373341599c4777c8d884****",
        "FpShotSlices" : [ {
          "Duplication" : {
            "Start" : "1260",
            "Duration" : "48"
          },
          "Similarity" : "0",
          "Input" : {
            "Start" : "46",
            "Duration" : "48"
          }
        } ],
        "Similarity" : "0.8914769887924194"
      } ],
      "TextFpShots" : [ {
        "PrimaryKey" : "3e34ac649945b53a1b0f863ce030****",
        "Similarity" : "1.0",
        "TextFpShotSlices" : [ {
          "Similarity" : "1.0",
          "InputText" : "It's snowy today.",
          "DuplicationText" : "It's snowy today.",
          "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",
    "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" : [ "ae687c02fe944327ba9631e50da23128****" ]
}

Error codes

For a list of error codes, see Service error codes.