All Products
Search
Document Center

ApsaraVideo Media Processing:SubmitFpDBDeleteJob

Last Updated:Sep 27, 2024

Submits a job of clearing or deleting a media fingerprint library.

Operation description

You can call this operation to clear or delete the specified media fingerprint library based on the library ID. If you clear a media fingerprint library, the content in the library is deleted, but the library is not deleted. If you delete a media fingerprint library, both the library and the content in the library are deleted. If you do not specify the operation type, the system clears the media fingerprint library by default.

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
mts:SubmitFpDBDeleteJob
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PipelineIdstringNo

The ID of the ApsaraVideo Media Processing (MPS) queue. This ID can be used to associate the job with a notification method. To view the MPS queue ID, log on to the MPS console and choose Global Settings > Pipelines in the left-side navigation pane.

fb712a6890464059b1b2ea7c8647****
FpDBIdstringYes

The ID of the media fingerprint library. You can obtain the library ID from the response parameters of the CreateFpShotDB operation.

88c6ca184c0e47098a5b665e2a12****
UserDatastringNo

The custom data. The value can contain letters and digits and can be up to 128 bytes in length.

example data
DelTypestringNo

The operation type. Valid values:

  • Purge: clears the media fingerprint library. The content in the library is deleted, but the library is not deleted.
  • Delete: deletes the media fingerprint library. Both the library and its content are deleted.
  • Default value: Purge.
Purge

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

4247B23C-26DE-529F-8D9F-FD6811AE979B
JobIdstring

The ID of the job. We recommend that you keep this ID for subsequent operation calls.

d98459323c024947a104f6a50cbf****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
500InternalErrorThe operation has failed due to some unknown error, exception or failure.

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