QueryIProductionJob - Query intelligent production job | MPS API - ApsaraVideo Media Processing

Queries an intelligent production job.

Operation description

The query results of this operation contain the processing results of the corresponding request algorithm.
If the response contains only RequestId and JobId, confirm whether the job is an intelligent production job.

QPS limit

The queries per second (QPS) limit for a single user of this operation is 100. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately. For more information, see QPS limit.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	No	The ID of the intelligent production job that you want to query. You can obtain the job ID from the response of the SubmitMediaProducingJob operation.	88c6ca184c0e432bbf5b665e2a15****

Response elements

Element	Type	Description	Example
	object	The response parameters.
FunctionName	string	The algorithm name. Valid values: VideoH2V: intelligent landscape-to-portrait. VideoDelogo: video logo removal. Cover: intelligent cover. VideoClip: video synopsis. ImageH2V: landscape-to-portrait. ImageDelogo: image logo removal. CaptionExtraction: caption extraction. VideoDetext: video caption removal. VideoGreenScreenMatting: image matting. MusicSegmentDetect: chorus detection. AudioMixing: audio mixing. AudioBeatDetection: beat detection. ImageCartoonize: 3D style and face stylization. To use the face stylization feature, contact the DingTalk account yuanzhigao1209. AudioQualityAssessment: audio quality assessment. Note Audio quality assessment supports 16-bit quantized WAV audio files with mono or stereo channels and a sampling rate range of 8000 to 48000 Hz.	ImageCartoonize
Input	string	The OSS bucket of the input file.	oss://example-****.oss-cn-hangzhou.aliyuncs.com/example.mp4
RequestId	string	The request ID.	D127C68E-F1A1-4CE5-A874-8FF724881A12
UserData	string	The user business data.	null
State	string	The job status. Valid values: Queuing: The job is queued. Analysing: The job is being analyzed. Fail: The job failed. Success: The job succeeded.	Success
Output	string	The OSS bucket of the output file.	oss://example-****.oss-cn-hangzhou.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt
PipelineId	string	The MPS queue ID.	39f8e0bc005e4f309379701645f4****
JobParams	string	The algorithm job parameters.	{mode:"gif"}
JobId	string	The job ID.	88c6ca184c0e432bbf5b665e2a15****
Result	string	The detailed information about the job result. For more information, see Supplementary description of intelligent production operation parameters.	{"Code":"Success","Data":"{\"result\":[{\"file\":\"iproduction/test-result.jpg\"},{\"file\":\"iproduction/test-origin.jpg\"}]}","Message":"Successful."}

Examples

Success response

JSON format

{
  "FunctionName": "ImageCartoonize",
  "Input": "oss://example-****.oss-cn-hangzhou.aliyuncs.com/example.mp4",
  "RequestId": "D127C68E-F1A1-4CE5-A874-8FF724881A12",
  "UserData": "null",
  "State": "Success",
  "Output": "oss://example-****.oss-cn-hangzhou.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt",
  "PipelineId": "39f8e0bc005e4f309379701645f4****",
  "JobParams": "{mode:\"gif\"}",
  "JobId": "88c6ca184c0e432bbf5b665e2a15****",
  "Result": "{\"Code\":\"Success\",\"Data\":\"{\\\"result\\\":[{\\\"file\\\":\\\"iproduction/test-result.jpg\\\"},{\\\"file\\\":\\\"iproduction/test-origin.jpg\\\"}]}\",\"Message\":\"Successful.\"}"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.