Submit a media fingerprint analysis job with SubmitFpShotJob - ApsaraVideo Media Processing - Alibaba Cloud - ApsaraVideo Media Processing

Operation description

Use this operation to submit jobs for video, audio, image, and text DNA analysis.
This is an asynchronous API. After you submit a job, the operation returns a job ID. The service then queues the job for background processing. When the job is complete, ApsaraVideo Media Processing sends a callback notification with the results. You can also call the QueryFpShotJob operation to check the job status.
The DNA analysis features are available in the China (Beijing), China (Shanghai), China (Hangzhou), Asia Pacific SE 1 (Singapore), and Saudi Arabia (Riyadh) regions. The service in the Saudi Arabia (Riyadh) region is operated by a partner. These features are not available in other regions. The text DNA analysis feature is supported only in the China (Shanghai) region.
The following input file formats are supported:
- Image formats: JPEG, PNG, and BMP.
- Video formats: MP4, AVI, MKV, MPG, TS, MOV, FLV, and MXF.
- Video codecs: MPEG-2, MPEG-4, H.264, HEVC, and WMV.
For text DNA analysis, the DNA library supports only long text strings that are added with TextType set to Text. The search input must be an Automatic Speech Recognition (ASR) result with TextType set to ASR. The ASR result must be a JSON array of objects that contain start, end, and text fields.

QPS limit

This operation is limited to 100 queries per second (QPS) per user. Calls that exceed this limit are subject to throttling, which may affect your business. Plan your calls accordingly. For more information, see QPS limits.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mts:SubmitFpShotJob

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Input	string	Yes	The input file for the job. You can specify the file by using an OSS URL, an HTTP URL, or an ApsaraVideo VOD media asset. OSS URL: A JSON string that contains the OSS triplet. Example: `{"Bucket":"test-bucket","Location":"oss-cn-shanghai","Object":"test.mp4"}` HTTP URL: A publicly accessible URL. Example: `http://example-test-**.mp4`. ApsaraVideo VOD media asset: a JSON string that contains the ID of the media asset. Example: `{"MediaId":"99238321"}` Note* The region of the OSS bucket and the storage region of the media asset must be the same as the region where you use the ApsaraVideo Media Processing service.	{"Bucket":"example-bucket-**","Location":"oss-cn-shanghai","Object":"example-**.flv"}
PipelineId	string	No	The ID of the pipeline used for message notifications. You can find the pipeline ID under Global Settings > Pipelines in the ApsaraVideo Media Processing console.	88c6ca184c0e47098a5b665e2a12****
FpShotConfig	string	Yes	The video DNA job configurations. The value must be a JSON object. For more information, see FpShotConfig.	{ "PrimaryKey": "12345**", "SaveType": "save", "FpDBId": "417f2ada5999daf**" }
UserData	string	No	The user-defined data. The value can be up to 128 bytes in length and cannot start with a special character.	testid-****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	25818875-5F78-4A13-BEF6-D7393642CA58
JobId	string	The video DNA job ID. We recommend that you save this ID for subsequent calls to related operations.	2a0697e35a7342859f733a9190c4****

Asynchronous notification parameters

Parameter	Type	Description
Type	String	The type of the message.
FpShotJobNotify	AliyunFpShotJobNotify	A video DNA job. For more information, see the AliyunFpShotJobNotify data type.
UserData	String	The user-defined data.

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.