QueryIProductionJob - Query an intelligent production job -

Queries an intelligent production job.

Description

The query results include the processing results of the requested algorithm.

QPS limits

The limit for this API is 100 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled, which can affect your business. We recommend that you call this API at a reasonable rate. For more information, see QPS limits.

Debug

You can use OpenAPI Explorer to test this API call and automatically generate SDK code examples. This eliminates the need to calculate signatures.

Test

Authorization information

The following table describes the authorization information for this API call. You can use this information in the Action element of a Resource Access Management (RAM) access policy to grant a RAM user or RAM role the permission to call this API. The items in the table are described as follows:

Operation: The specific permission.
Access level: The access level of each operation. Valid values are Write, Read, and List.
Resource type: The resource type that can be authorized for an operation.
- An asterisk (*) indicates a required resource type.
- If an operation does not support resource-level authorization, this item is set to All resources
Condition key: The condition keys that are defined by the cloud product.
Associated operation: The other permissions required to perform this operation. You must also have the permissions for the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mts:QueryIProductionJob	retrieve	All resources ``	None	None

Request parameters

Name	Type	Required	Description	Example
JobId	string	No	The ID of the intelligent production job that you want to query. Obtain this ID from the response to the SubmitIProductionJob operation.	88c6ca184c0e432bbf5b665e2a15****

Response parameters

Name	Type	Description	Example
	object	The response parameters.
FunctionName	string	The name of the algorithm. Valid values: VideoH2V: Converts a horizontal video to a vertical one. VideoDelogo: Removes logos from a video. Cover: Smart thumbnail. VideoClip: video synopsis. ImageH2V: Converts a horizontal image to a vertical one. ImageDelogo: Removes logos from an image. CaptionExtraction: caption extraction. VideoDetext: Removes captions from a video. VideoGreenScreenMatting: image matting. MusicSegmentDetect: Detects the chorus in a song. AudioMixing: Mixes audio. AudioBeatDetection: Detects beats in audio. ImageCartoonize: 3D style and facial stylization. To use the facial stylization feature, contact us on DingTalk at yuanzhigao1209. AudioQualityAssessment: Detects audio quality. Note The audio quality detection feature supports 16 bit quantized WAV audio files. It supports mono and stereo sound channels. The supported sample rate range is 8,000 Hz to 48,000 Hz.	ImageCartoonize
Input	string	The OSS bucket that contains 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-defined data.	null
State	string	The job state. Valid values: Queuing: The job is in a queue. Analysing: The job is being analyzed. Fail: The job failed. Success: The job is successful.	Success
Output	string	The OSS bucket that contains the output file.	oss://example-****.oss-cn-hangzhou.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt
PipelineId	string	The ID of the MPS queue for the job.	39f8e0bc005e4f309379701645f4****
JobParams	string	The parameters of the algorithm job.	{mode:"gif"}
JobId	string	The job ID.	88c6ca184c0e432bbf5b665e2a15****
Result	string	The detailed information about the job result. For more information, see Additional information about the parameters for intelligent production APIs.	{"Code":"Success","Data":"{\"result\":[{\"file\":\"iproduction/test-result.jpg\"},{\"file\":\"iproduction/test-origin.jpg\"}]}","Message":"Successful."}

Examples

Successful response example

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

For a list of error codes, see the API Error Center.

Change history

Change time	Description	Operations

No change history.