Use QueryFpFileDeleteJobList to query file deletion jobs - ApsaraVideo Media Processing - Alibaba Cloud - ApsaraVideo Media Processing

Queries DNA file deletion jobs.

Operation description

This operation queries the details of DNA file deletion jobs by job ID. If no job ID is specified, it returns a list of the 20 most recent jobs.

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 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:QueryFpFileDeleteJobList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobIds	string	No	The IDs of the DNA deletion jobs. You can obtain the IDs from the response parameters of the Submit a DNA file deletion job operation. Separate multiple IDs with commas (,). If this parameter is left empty, a list of the 20 most recent jobs is returned.	d98459323c024947a104f6a50cbf**,c2dc694696f1441591c5012a73c1**

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	D127C68E-F1A1-4CE5-A874-8FF724881A12
FpFileDeleteJobList	object
FpFileDeleteJob	array<object>	The list of DNA deletion jobs. For more information, see FpFileDeleteJob data type.
	object	The response parameters.
CreationTime	string	The time when the job was created. The time is displayed in UTC and follows the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format.	2020-06-30T00:33:18Z
Status	string	The status of the job. Valid values: Queuing: The job is queued. Analysing: The job is being analyzed. Success: The job succeeded. Fail: The job failed.	Success
FinishTime	string	The time when the job was completed. The time is displayed in UTC and follows the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format.	2020-06-30T00:34:02Z
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 succeeds.	ServiceUnavailable
Message	string	The error message returned when the analysis fails. This parameter is not returned if the job succeeds.	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****
FileIds	string	The IDs of the files.	41e6536e4f2250e2e9bf26cdea19****
NonExistIds	object
String	array	The response parameters.
	string	The list of IDs of jobs that do not exist.	c2dc694696f1441591c5012a73c1****

Examples

Success response

JSON format

{
  "RequestId": "D127C68E-F1A1-4CE5-A874-8FF724881A12",
  "FpFileDeleteJobList": {
    "FpFileDeleteJob": [
      {
        "CreationTime": "2020-06-30T00:33:18Z",
        "Status": "Success",
        "FinishTime": "2020-06-30T00:34:02Z",
        "UserData": "example data",
        "Code": "ServiceUnavailable",
        "Message": "The request has failed due to a temporary failure of the server.",
        "PipelineId": "fb712a6890464059b1b2ea7c8647****",
        "FpDBId": "88c6ca184c0e47098a5b665e2a12****",
        "Id": "25bacf2824614bcf9273dc0744db****",
        "FileIds": "41e6536e4f2250e2e9bf26cdea19****"
      }
    ]
  },
  "NonExistIds": {
    "String": [
      "c2dc694696f1441591c5012a73c1****"
    ]
  }
}

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.