Submits a job to delete media files from a media fingerprint library.
Operation description
Limits
-
Deletes up to 200 media files from a media fingerprint library at a time.
-
Available in the following regions: China (Beijing), China (Hangzhou), China (Shanghai), and Singapore.
QPS limits
You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. For more information, see QPS limits.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
mts:SubmitFpFileDeleteJob |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| PipelineId |
string |
No |
The ID of the ApsaraVideo Media Processing (MPS) queue to which the job is submitted. The MPS queue is bound with a notification method. To view the queue ID, log on to the MPS console and choose Global Settings > MPS queue and Callback. |
ed450ea0bfbd41e29f80a401fb4d**** |
| FpDBId |
string |
Yes |
The ID of the media fingerprint library. Obtain the library ID from the response of the CreateFpShotDB operation. |
88c6ca184c0e432bbf5b665e2a15**** |
| UserData |
string |
No |
The custom data. The value can contain letters and digits and can be up to 128 bytes in length. |
example data |
| FileIds |
string |
No |
The IDs of the media files to delete. Separate multiple file IDs with commas (,). You can delete up to 200 media files at a time. Obtain the file IDs from the response of the ListFpShotFiles operation. |
41e6536e4f2250e2e9bf26cdea19**** |
| PrimaryKeys |
string |
No |
The primary keys of the files to delete. Separate multiple primary keys with commas (,). You can delete up to 200 primary keys at a time. Obtain the primary keys from the response of the ListFpShotFiles operation. Note
This parameter is available only in the China (Beijing), China (Hangzhou), and China (Shanghai) regions. |
24e0fba7188fae707e146esa54**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
D127C68E-F1A1-4CE5-A874-8FF724881A12 |
| JobId |
string |
The job ID. |
39f8e0bc005e4f309379701645f4**** |
Examples
Success response
JSON format
{
"RequestId": "D127C68E-F1A1-4CE5-A874-8FF724881A12",
"JobId": "39f8e0bc005e4f309379701645f4****"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter.DBNotExist | The DNA database does not exist. | |
| 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.