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

Operation description

This operation creates video, audio, image, and text media fingerprint libraries.
Text media fingerprint-related operations are currently supported only in the China (Shanghai) region.
Each user can create up to 5 fingerprint libraries by default. To increase this limit, submit a ticket. To delete unused fingerprint libraries, call the SubmitFpDBDeleteJob operation.

QPS limit

The single-user QPS limit for this operation is 100 calls per second. If this limit is exceeded, API calls are throttled, which may affect your business. Use this operation appropriately. 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. Text media fingerprint ModelId: 11 (deprecated) Video media fingerprint ModelId: 12 Audio media fingerprint ModelId: 13 Image media fingerprint ModelId: 14 (deprecated)	12
Config	string	No	The configuration of the fingerprint library. This parameter is left empty by default for custom configurations. The value is a string in JSON format.	null
Description	string	No	The description of the media fingerprint library.	This is a text media fingerprint library

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	25818875-5F78-4A13-BEF6-D7393642CA58
FpShotDB	object	The details of the media fingerprint library.
Description	string	The description of the media fingerprint library.	This is a text media fingerprint library
State	string	The status of the media fingerprint library. After the library is created, the default status is offline. The status automatically transforms to active after spooling is complete.	offline
Name	string	The name of the media fingerprint library.	example-name-****
FpDBId	string	The ID of the media fingerprint library. Save this ID for use when you call other related operations.	88c6ca184c0e47098a5b665e2a12****
ModelId	integer	The model ID of the media fingerprint library.	11
Config	string	The configuration 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.