Submits a media fingerprint analysis job to query the media fingerprint repository for a media file with the identical or similar fingerprint as the input file.
Operation description
-
You can call this operation to submit a video, audio, image, 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. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| mts:SubmitFpShotJob | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Input | string | Yes | The OSS URL of the job input. The value is a JSON object. You can query the OSS URL in the OSS or MPS console. Note
The OSS bucket must reside in the same region as your MPS service.
| {"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.flv"} |
| PipelineId | string | No | The ID of the MPS queue. This ID can be used to associate the job with a notification method. To view the ID of the MPS queue, perform the following steps: Log on to the MPS console. In the left-side navigation pane, choose Global Settings > Pipelines. | 88c6ca184c0e47098a5b665e2a12**** |
| FpShotConfig | string | Yes | 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. | { "PrimaryKey": "12345****", "SaveType": "save", "FpDBId": "417f2ada5999daf****" } |
| UserData | string | No | The custom data. The value can be up to 128 bytes in length and cannot start with a special character. | testid-**** |
Response parameters
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 success responses
JSONformat
{
"RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
"JobId": "2a0697e35a7342859f733a9190c4****"
}Error codes
For a list of error codes, visit the Service error codes.