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

Operation description

This operation clears or deletes a DNA library by specifying the DNA library ID. Clearing a DNA library removes all content in the library without deleting the library itself, whereas deleting a DNA library removes the library entirely. If the operation type is not specified, the DNA library is cleared by default. Note that new fingerprint libraries with a modelId in the range of [11, 14] only support the delete operation, which means DelType must be set to Delete.

QPS limit

The QPS limit for a single user is 100 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Make API calls at a reasonable rate. 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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PipelineId	string	No	The ID of the MPS queue, which is used to bind message notifications. You can obtain the ID by choosing MPS console > Global settings > MPS queues.	fb712a6890464059b1b2ea7c8647****
FpDBId	string	Yes	The ID of the DNA library. You can obtain the ID from the response parameters of the Submit a DNA library creation job operation.	88c6ca184c0e47098a5b665e2a12****
UserData	string	No	The custom data. It supports Chinese and English characters, digits, and other characters, and can be up to 128 bytes in length.	example data
DelType	string	No	The operation type. Valid values: Purge: clears the DNA library. This removes all content in the DNA library without deleting the library itself. Delete: deletes the DNA library. New fingerprint libraries with a modelId in the range of [11, 14] only support this operation. Default value: Purge.	Purge

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	4247B23C-26DE-529F-8D9F-FD6811AE979B
JobId	string	The ID of the job that clears or deletes the DNA library. Save this ID for use in 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.