SubmitIProductionJob - Submit an intelligent production job - Alibaba Cloud - ApsaraVideo Media Processing

Submits an intelligent production job.

Operation description

Jobs committed by invoking this operation are executed in asynchronous mode. The job is added to an MPS queue for scheduling and execution. You can invoke the QueryIProductionJob operation to query the job execution result, or use the asynchronous message notification mechanism to obtain the result.

QPS limit

You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. This may affect your business. 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:SubmitIProductionJob

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FunctionName	string	Yes	The name of the algorithm. For the regions supported by each algorithm, see Regions. Valid values: VideoH2V: intelligent landscape-to-portrait for video VideoDelogo: video logo removal Cover: intelligent cover VideoClip: video synopsis ImageH2V: intelligent landscape-to-portrait for image ImageDelogo: image logo removal CaptionExtraction: caption extraction (the algorithm takes the URL of the video to be processed as input and outputs the extracted caption file) VideoDetext: video caption removal VideoGreenScreenMatting: image matting (the algorithm takes the URL of the video to be matted and the URL of the replacement background image as input, and outputs the composited video) MusicSegmentDetect: chorus detection (takes the URL of the audio or video to be processed as input, and outputs the start and end times of each detected chorus segment. If no chorus is detected, an empty result is returned) AudioMixing: audio mixing AudioBeatDetection: beat detection (takes the URL of the audio or video to be processed as input, and outputs the detected beat time list BeatList and downbeat time list DownBeatList) ImageCartoonize: 3D style and face stylization (to use the face stylization feature, contact the DingTalk account yuanzhigao1209) AudioQualityAssessment: audio quality assessment FaceBeauty: video face beautification SpeechDenoise: intelligent noise reduction Note Audio quality assessment supports 16-bit quantized WAV audio files, mono or stereo channels, and sampling rates ranging from 8000 to 48000 Hz.	ImageCartoonize
ModelId	string	No	The algorithm model ID. If this parameter is left empty, the default model for the corresponding algorithm is used. In most cases, leave this parameter empty to use the default model.	null
JobParams	string	No	The algorithm job parameters. This is a JSON object, and the content varies depending on the algorithm. For more information, see Supplementary description of intelligent production operation parameters.	{"Model":"gif"}
ScheduleParams	string	No	The job scheduling parameters for configuring task scheduling. This parameter is optional. Leave it empty if not needed.	null
NotifyUrl	string	No	The callback URL. Currently, only MNS MSMQ are supported. You can view the MSMQ path in the MNS console > Queue List > Details.	mns://125340688170****.mns.cn-beijing.aliyuncs.com/queues/example-pipeline
UserData	string	No	The custom business data that is returned in the callback message to the callback URL. This parameter is optional. Leave it empty if not needed.	{\"key\":\"value\"}
PipelineId	string	No	The ID of the MPS queue. You can obtain the ID from the MPS console > Global Settings > MPS Queue. This parameter is used to determine the job callback queue and provide tenant isolation. If this parameter is not specified, the default MPS queue is used, which supports a maximum of 10 concurrent jobs and is not bound to message notifications.	39f8e0bc005e4f309379701645f4****
Input	string	No	The OSS Bucket of the input file. Currently, only OSS paths are supported, and the region of the OSS bucket must be the same as the region of the current MPS service. You can obtain the path from the MPS console > Media Management > Media Library or by selecting the corresponding bucket in the OSS console. Note Depending on the algorithm, Input may be required in certain scenarios. Specify this parameter based on your business requirements.	oss://example-****.oss-cn-shanghai.aliyuncs.com/example.mp4
Output	string	No	The OSS Bucket of the output file. Currently, only OSS paths are supported. You can obtain the path from the MPS console > Media Management > Media Library or by selecting the corresponding bucket in the OSS console. The region of the OSS bucket must be the same as the region of the current MPS service. Note The format is `oss://example-****.oss-cn-shanghai.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt`, where `{source}`, `{timestamp}`, and `{sequenceId}` are placeholders that are populated with the input file name, UNIX timestamp, and sequence number, respectively. The placeholders are not mandatory. However, for algorithms that produce multiple outputs, such as intelligent cover, include the sequence number placeholder to ensure unique output file paths. The file extension is user-defined.	oss://example-****.oss-cn-shanghai.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	5210DBB0-E327-4D45-ADBC-0B83C8796E26
JobId	string	The job ID. Save this ID for use when calling other operations.	39f8e0bc005e4f309379701645f4****
Result	string	The returned result. The result varies depending on the algorithm. For more information, see Supplementary description of intelligent production operation parameters.	{ "Code":"Success", "Details":[], "FunctionName":"ImageCartoonize", "JobId":"39f8e0bc005e4f309379701645f4****", "Message":"success", "State":"Success", "Type":"IProduction" }

Examples

Success response

JSON format

{
  "RequestId": "5210DBB0-E327-4D45-ADBC-0B83C8796E26",
  "JobId": "39f8e0bc005e4f309379701645f4****",
  "Result": "{ \"Code\":\"Success\", \"Details\":[], \"FunctionName\":\"ImageCartoonize\", \"JobId\":\"39f8e0bc005e4f309379701645f4****\", \"Message\":\"success\", \"State\":\"Success\", \"Type\":\"IProduction\" }"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.