Use CreateFpShotDB to create a media fingerprint library - ApsaraVideo Media Processing

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.

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:CreateFpShotDB

create

*All Resource

*

None

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.	12
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.	这是一个文本DNA库

Response elements

Element	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.	这是一个文本DNA库
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

Success response

JSON format

{
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  "FpShotDB": {
    "Description": "这是一个文本DNA库",
    "State": "offline",
    "Name": "example-name-****",
    "FpDBId": "88c6ca184c0e47098a5b665e2a12****",
    "ModelId": 11,
    "Config": "null"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.