Submits an intelligent production job.
Description
Jobs submitted by this operation are executed asynchronously. The jobs are added to an MPS queue for scheduling and execution. You can call the QueryIProductionJob operation to query the job result. You can also use asynchronous message notifications to obtain the result.
QPS limits
The queries per second (QPS) limit for a single user is 100 calls per second. Throttling is triggered if the limit is exceeded. This may affect your business operations. Plan your calls accordingly. For more information, see QPS limits.
Debug
Authorization information
The following table describes the authorization information for this API call. You can add the information to the Action element of a Resource Access Management (RAM) access policy to grant a RAM user or a RAM role the permissions to call this API. Details:
- Operation: The specific permission.
- Access level: The access level of each operation. Valid values: Write, Read, and List.
- Resource type: The type of resource that supports authorization. Details:
- An asterisk ( * ) indicates a required resource type.
- If an operation does not support resource-level authorization,
All Resources
- Condition key: The condition keys that are defined by the cloud service.
- Associated operation: Other permissions that are required to call the operation. To call the operation, you must also have permissions for the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| mts:SubmitIProductionJob | *All Resources * |
| None |
Request parameters
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| FunctionName | string | Yes | The name of the feature algorithm. For information about the regions that support each feature algorithm, see Service regions. Valid values:
| ImageCartoonize |
| ModelId | string | No | The ID of the algorithm model. If you leave this parameter empty, the default model for the specified feature is used. In most cases, you can leave this parameter empty and use the default model. | null |
| JobParams | string | Yes | The parameters for the algorithm job. This is a JSON object. The parameters vary based on the algorithm. For more information, see Supplementary parameters for intelligent production operations. | {"Model":"gif"} |
| ScheduleParams | string | No | The job scheduling parameters. This parameter specifies the job scheduling configuration. This parameter is optional. You can leave it empty. | null |
| NotifyUrl | string | No | The callback path. Only Message Service (MNS) queues are supported. To view the path of an MNS queue, go to the MNS console and choose Queues > Details. | mns://125340688170****.mns.cn-beijing.aliyuncs.com/queues/example-pipeline |
| UserData | string | No | Custom business data. This data is returned to the specified webhook address along with the callback information. This parameter is optional. You can leave it empty. | {\"key\":\"value\"} |
| PipelineId | string | No | The ID of the MPS queue. To obtain the ID, go to the MPS console and choose Global Settings > Pipelines. This parameter is used to specify the job callback queue and provide tenant fencing. If you do not specify this parameter, the default MPS queue is used. The default job concurrency is 10, and no message notification is attached. | 39f8e0bc005e4f309379701645f4**** |
| Input | string | No | The Object Storage Service (OSS) path of the input file. The region of the OSS bucket must be the same as the region where MPS resides. To obtain the path, go to the MPS console and choose Media Management > Media Library, or go to the OSS console and select the desired bucket. Note
The Input parameter is required in some scenarios because algorithms vary. Specify this parameter as needed.
| oss://example-****.oss-cn-shanghai.aliyuncs.com/example.mp4 |
| Output | string | No | The OSS path of the output file. The region of the OSS bucket must be the same as the region where MPS resides. To obtain the path, go to the MPS console and choose Media Management > Media Library, or go to the OSS console and select the desired bucket. Note
The format is oss://example-****.oss-cn-shanghai.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt. The {source}, {timestamp}, and {sequenceId} are placeholders that represent the input filename, UNIX timestamp, and ordinal number, respectively. The placeholders are optional. However, for algorithms that produce multiple outputs, such as smart thumbnail, you must add the ordinal number placeholder to ensure that the output file paths are unique. You can customize the file extension.
| oss://example-****.oss-cn-shanghai.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt |
Response parameters
Examples
Example 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
For a list of error codes, see the API Error Center.
Change history
| Change time | Description | Operations |
|---|