Submits a job to delete DNA files.
Operation description
-
This operation deletes up to 200 DNA files at a time.
-
This operation is currently supported in the China (Beijing), China (Hangzhou), China (Shanghai), Singapore, and Saudi Arabia (Riyadh) regions.
QPS limits
The QPS limit for a single user is 10 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
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
mts:SubmitFpFileDeleteJob |
update |
*All Resource
|
None | 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 navigating to MPS Console > Global Settings > MPS Queues. |
ed450ea0bfbd41e29f80a401fb4d**** |
| FpDBId |
string |
Yes |
The ID of the DNA library. You can obtain the ID from the response parameters of Submit a DNA library creation job. |
88c6ca184c0e432bbf5b665e2a15**** |
| UserData |
string |
No |
The custom user data, which supports Chinese and English characters and digits. The maximum length is 128 bytes. |
example data |
| FileIds |
string |
No |
The IDs of the files to be deleted. Separate multiple IDs with commas (,). You can delete up to 200 files at a time. You can obtain the IDs from the response parameters of Query the file list of a DNA library. |
41e6536e4f2250e2e9bf26cdea19**** |
| PrimaryKeys |
string |
No |
The primary keys of the files to be deleted. Separate multiple primary keys with commas (,). You can delete up to 200 files at a time. You can obtain the primary keys from the response parameters of Query the file list of a DNA library. Note
This parameter is currently supported 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 ID of the request. |
D127C68E-F1A1-4CE5-A874-8FF724881A12 |
| JobId |
string |
The ID of the DNA file deletion job. |
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.