CreateFpShotDB - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

Submits a job of creating a media fingerprint library.

Operation description

You can call this operation to submit a job to create a video or text fingerprint library. You can use a text fingerprint library to store fingerprints for text.
You can submit a job of creating a text fingerprint library only in the China (Shanghai) region.
By default, you can submit up to 10 jobs of creating a video fingerprint library to an ApsaraVideo Media Processing (MPS) queue at a time. If you submit more than 10 jobs at a time, the call may fail.

QPS limit

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the media fingerprint library.	example name
ModelId	integer	No	The model ID of the media fingerprint library. To create a text fingerprint library, set the parameter to 11. To create a video fingerprint library, set the parameter to 12. To create an audio fingerprint library, set the parameter to 13. To create an image fingerprint library, set the parameter to 14.	11
Config	string	No	The configurations of the media fingerprint library. By default, this parameter is left empty. You can customize the configurations based on your business requirements. The value must be a string in the JSON format.	null
Description	string	No	The description of the media fingerprint library.	The library is a text fingerprint library.

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	25818875-5F78-4A13-BEF6-D7393642CA58
FpShotDB	object	The details of the media fingerprint library.
Description	string	The description of the media fingerprint library.	The library is a text fingerprint library.
State	string	The status of the media fingerprint library. After the media fingerprint library is created, it enters the offline state. After the media fingerprint library is processed at the backend, it enters the active state.	offline
Name	string	The name of the media fingerprint library.	example-name-****
FpDBId	string	The ID of the media fingerprint library. We recommend that you keep this ID for subsequent operation calls.	88c6ca184c0e47098a5b665e2a12****
ModelId	integer	The model ID of the media fingerprint library.	11
Config	string	The configurations of the media fingerprint library.	null

Examples

Sample success responses

JSONformat

{
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  "FpShotDB": {
    "Description": "The library is a text fingerprint library.\n",
    "State": "offline",
    "Name": "example-name-****",
    "FpDBId": "88c6ca184c0e47098a5b665e2a12****",
    "ModelId": 11,
    "Config": "null"
  }
}

Error codes

For a list of error codes, visit the Service error codes.