Submits a media fingerprint analysis job to search a media fingerprint library for media files that have the same or similar fingerprints as an input media file.

Usage notes

  • You can call this operation to submit a video or text fingerprint analysis job.
  • This operation asynchronously submits a job. The query results may not have been generated when the response is returned. After the results are generated, an asynchronous message is returned.
  • You can submit a text fingerprint analysis job only in the China (Shanghai) region. The input file of the job must be in one of the following formats:
    • Image formats: JPEG, PNG, and BMP.
    • Video formats: MP4, AVI, MKV, MPG, TS, MOV, FLV, MXF.
    • Video encoding formats: MPEG2, MPEG4, H264, HEVC, and WMV.

QPS limit

You can call this operation up to 150 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 SubmitFpShotJob

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

Input String Yes {"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.flv"}

The object Storage Service (OSS) URL of the job input. The value is a JSON object. You can query the OSS URL in the OSS or ApsaraVideo Media Processing (MPS) console. For more information, see the "InputFile" section of the Parameter details topic.

Note The OSS bucket must reside in the same region as the specified MPS region.
PipelineId String No 88c6ca184c0e47098a5b665e2a12****

The ID of the MPS queue. This ID can be used to associate the job with a notification method. To view the MPS queue ID, log on to the MPS console and choose Global Settings > Pipelines in the left-side navigation pane.

FpShotConfig String Yes {"PrimaryKey":"12345****", "SaveType": "save"}

The configurations of the media fingerprint analysis job. The value is a JSON object. For more information, see the "FpShotConfig" section of the Parameter details topic.

UserData String No testid-****

The custom data. The value can be up to 128 bytes in length and cannot start with a special character.

Response parameters

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

The ID of the request.

JobId String 2a0697e35a7342859f733a9190c4****

The ID of the media fingerprint analysis job. We recommend that you keep this ID for subsequent operation calls.

Asynchronous notification parameters

Parameter

Type

Description

Type

String

The type of the message.

FpShotJobNotify

AliyunFpShotJobNotify

The notification of the results of the media fingerprint analysis job. For more information, see the "AliyunFpShotJobNotify" section of the Data types topic.

UserData

String

The custom data.

Examples

Sample requests

http(s)://mts.cn-shanghai.aliyuncs.com/?Action=SubmitFpShotJob
&Input={"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.flv"}
&PipelineId=88c6ca184c0e47098a5b665e2a12****
&FpShotConfig={"PrimaryKey":"12345****", "SaveType": "save"}
&UserData=testid-****
&<Common request parameters>

Sample success responses

XML format 

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

<SubmitFpShotJobResponse>
    <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
    <JobId>2a0697e35a7342859f733a9190c4****</JobId>
</SubmitFpShotJobResponse>

JSON format 

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

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

Error codes

For a list of error codes, visit the API Error Center.