Queries DNA library deletion jobs.
Operation description
This operation queries jobs based on the IDs of jobs that clear or delete DNA libraries. If no IDs are specified, a list of the latest 20 jobs is returned by default.
QPS limits
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 services. Call this operation properly. For more information, see QPS limits.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
mts:QueryFpDBDeleteJobList |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| JobIds |
string |
No |
The IDs of the jobs that clear or delete DNA libraries. You can obtain the IDs from the response parameters of Submit a job to clear or delete a DNA library. Separate multiple IDs with commas (,). If this parameter is left empty, a list of the latest 20 jobs is returned. |
2288c6ca184c0e47098a5b665e2a12****,78dc866518b843259669df58ed30**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The ID of the request. |
4247B23C-26DE-529F-8D9F-FD6811AE979B |
| FpDBDeleteJobList |
object |
||
| FpDBDeleteJob |
array<object> |
The list of DNA library deletion jobs. For more information, see FpDBDeleteJob. |
|
|
object |
The response parameters. |
||
| CreationTime |
string |
The creation time. |
2020-06-30T00:33:18Z |
| Status |
string |
The job status. Valid values:
|
Success |
| FinishTime |
string |
The completion time. |
2020-06-30T00:34:02Z |
| DelType |
string |
The operation type. |
Purge |
| UserData |
string |
The custom user data. |
example data |
| Code |
string |
The error code returned when the analysis fails. This parameter is not returned if the job is successful. |
ServiceUnavailable |
| Message |
string |
The error message returned when the analysis fails. This parameter is not returned if the job is successful. |
The request has failed due to a temporary failure of the server. |
| PipelineId |
string |
The ID of the MPS queue. |
fb712a6890464059b1b2ea7c8647**** |
| FpDBId |
string |
The ID of the DNA library. |
88c6ca184c0e47098a5b665e2a12**** |
| Id |
string |
The ID of the job. |
25bacf2824614bcf9273dc0744db**** |
| NonExistIds |
object |
||
| String |
array |
The list of non-existent IDs. |
|
|
string |
The list of non-existent job IDs. This parameter is not returned if the list is empty. |
78dc866518b843259669df58ed30**** |
Examples
Success response
JSON format
{
"RequestId": "4247B23C-26DE-529F-8D9F-FD6811AE979B",
"FpDBDeleteJobList": {
"FpDBDeleteJob": [
{
"CreationTime": "2020-06-30T00:33:18Z",
"Status": "Success",
"FinishTime": "2020-06-30T00:34:02Z",
"DelType": "Purge",
"UserData": "example data",
"Code": "ServiceUnavailable",
"Message": "The request has failed due to a temporary failure of the server.",
"PipelineId": "fb712a6890464059b1b2ea7c8647****",
"FpDBId": "88c6ca184c0e47098a5b665e2a12****",
"Id": "25bacf2824614bcf9273dc0744db****"
}
]
},
"NonExistIds": {
"String": [
"78dc866518b843259669df58ed30****"
]
}
}
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.