Use QueryFpDBDeleteJobList to query jobs for clearing or deleting a media fingerprint library - ApsaraVideo Media Processing

Queries the status of one or more jobs submitted to clear or delete a media fingerprint library (FpDB).

Operation description

You can call this operation to query jobs by specifying their job IDs. If you do not provide any job IDs, the operation returns a list of the 20 most recent jobs.

QPS limit

The QPS limit for this operation is 100 calls per second per account. Exceeding this limit triggers throttling, which may affect your business. 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:QueryFpDBDeleteJobList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobIds	string	No	The IDs of the jobs to query. You can get job IDs from the response of the SubmitFpDBDeleteJob operation. To query multiple jobs, separate the IDs with a comma (,). If you omit this parameter, the operation returns the 20 most recent jobs.	2288c6ca184c0e47098a5b665e2a12**,78dc866518b843259669df58ed30**

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	4247B23C-26DE-529F-8D9F-FD6811AE979B
FpDBDeleteJobList	object	A list of jobs.
FpDBDeleteJob	array<object>	The list of FpDB deletion jobs. For more information, see FpDBDeleteJob.
	object	The response parameters.
CreationTime	string	The time when the job was created.	2020-06-30T00:33:18Z
Status	string	The status of the job. Valid values: Queuing: The job is in the queue. Analyzing: The job is being analyzed. Success: The job completed successfully. Fail: The job failed.	Success
FinishTime	string	The time when the job was completed.	2020-06-30T00:34:02Z
DelType	string	The operation type.	Purge
UserData	string	The custom data that was passed in the request.	example data
Code	string	The error code for a failed job.	ServiceUnavailable
Message	string	The error message for a failed job.	The request has failed due to a temporary failure of the server.
PipelineId	string	The ID of the pipeline.	fb712a6890464059b1b2ea7c8647****
FpDBId	string	The ID of the media fingerprint library.	88c6ca184c0e47098a5b665e2a12****
Id	string	The job ID.	25bacf2824614bcf9273dc0744db****
NonExistIds	object	A list of job IDs that do not exist.
String	array	A list of job IDs that do not exist.
	string	A job ID that could not be found.	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.