Call SubmitFpDBDeleteJob to clear or delete a media fingerprint library - ApsaraVideo Media Processing

Operation description

This operation purges or deletes a DNA library by its ID. You can choose one of two operations: Purge or Delete. The Purge operation removes all content from the DNA library but preserves the library. The Delete operation permanently removes the library. If you do not specify an operation type, Purge is used by default. Note that fingerprint libraries with a modelId from 11 to 14 support only the Delete operation.

QPS limit

The rate limit for this operation is 100 queries per second (QPS) per user. If you exceed this limit, your API calls will be throttled, which may affect your business. 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:SubmitFpDBDeleteJob

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PipelineId	string	No	The ID of the ApsaraVideo Media Processing (MPS) pipeline for the job. MPS uses this ID to send message notifications. You can obtain the pipeline ID in the MPS console by navigating to Global Settings > Pipelines.	fb712a6890464059b1b2ea7c8647****
FpDBId	string	Yes	The API call to create a DNA library returns this ID in its response.	88c6ca184c0e47098a5b665e2a12****
UserData	string	No	The user-defined data. The value can be a string of up to 128 bytes.	example data
DelType	string	No	The type of operation. Valid values: Purge: Purges the DNA library. This operation removes all content from the library but does not delete the library itself. Delete: Deletes the DNA library. This operation permanently removes the library. Note: This is the only supported operation for fingerprint libraries with a `modelId` from 11 to 14. Default value: Purge.	Purge

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	4247B23C-26DE-529F-8D9F-FD6811AE979B
JobId	string	The ID of the submitted job. We recommend that you save this ID for subsequent API calls.	d98459323c024947a104f6a50cbf****

Examples

Success response

JSON format

{
  "RequestId": "4247B23C-26DE-529F-8D9F-FD6811AE979B",
  "JobId": "d98459323c024947a104f6a50cbf****"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The operation has failed due to some unknown error, exception or failure.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.