DocsICP FilingConsole
官方文档
首页

QueryIProductionJob

更新时间：
复制 MD 格式
产品详情
我的收藏

Call QueryIProductionJob to get the status and result of an intelligent production job.

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

ice:QueryIProductionJob

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
ClientToken

string

No

A token that ensures request idempotence.

JobId

string

Yes

The intelligent job ID.

****20b48fb04483915d4f2cd8ac****

Response elements

Element

Type

Description

Example

object

The response schema.

RequestId

string

The request ID.

JobId

string

The job ID.

****20b48fb04483915d4f2cd8ac****
Name

string

The job name.

测试任务
FunctionName

string

The name of the algorithm to use. Valid values:

  • Cover: smart cover

  • VideoClip: video summary

  • VideoDelogo: video logo removal

  • VideoDetext: video text removal

  • CaptionExtraction: caption extraction

  • VideoGreenScreenMatting: green screen matting

  • FaceBeauty: video beautification

  • VideoH2V: horizontal-to-vertical video conversion

  • MusicSegmentDetect: chorus detection

  • AudioBeatDetection: beat detection

  • AudioQualityAssessment: audio quality assessment

  • SpeechDenoise: speech denoising

  • AudioMixing: audio mixing

  • MusicDemix: music source separation

Cover
Input

object

The input media.

Type

string

The input type. Valid values:

  1. OSS: An OSS file URL.

  2. Media: A media asset ID.

OSS
Media

string

The source file for the job. Set this to an OSS file URL if Type is OSS, or a media asset ID if Type is Media. Valid OSS URL formats:

  1. oss://bucket/object

  2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object In these formats, bucket is the name of the OSS bucket in the same region as the current project, and object is the file path.

oss://bucket/object
Output

object

The output media.

Type

string

The media type. Valid values:

  • OSS: An OSS file URL.

  • Media: A media asset ID.

OSS
Biz

string

The service that the media asset belongs to.

Valid values:

  • VOD :

    VOD

  • IMS :

    IMS

IMS
Media

string

The destination for the output. If the output Type is OSS, this parameter returns an OSS file URL. If the output Type is Media, it returns the specified or a newly generated media asset ID.

Valid OSS URL formats:

  1. oss://bucket/object

  2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object In these formats, bucket is the name of the OSS bucket in the same region as the current project, and object is the file path.

oss://bucket/object
OutputUrl

string

The OSS URL of the output file. This value is returned only when Type is Media.

http(s)://bucket.oss-[RegionId].aliyuncs.com/object

TemplateId

string

The template ID.

****96e8864746a0b6f3****
JobParams

string

A JSON object that contains the parameters for the algorithm job. The specific parameters vary depending on the selected algorithm.

{"Model":"gif"}
ScheduleConfig

object

The job configuration.

PipelineId

string

The pipeline ID.

a54fdc9c9aab413caef0d1150f565e86
Priority

integer

The job's priority within the pipeline.

  • A larger value indicates a higher priority. The highest priority is 10.

  • Default: 6.

6
UserData

string

The user data. The system returns this value unchanged.

{"test":1}
Result

string

The algorithm output, returned as a JSON string. The structure of the output varies based on the FunctionName. For more information, see the additional notes below.

{}
CreateTime

string

The time when the job was created, in UTC.

2022-07-07T07:16:11Z
FinishTime

string

The time when the job was completed, in UTC.

2021-11-26T14:50:25Z
Status

string

The job status. Valid values:

  • Queuing: The job is awaiting processing.

  • Analyzing: The job is being processed.

  • Fail: The job failed to complete.

  • Success: The job completed successfully.

Success
OutputFiles

array

An array of output file paths.

string

The path and name of the generated file.

output/xxx.mp4
OutputMediaIds

array

string

OutputUrls

array

An array of output file URLs.

string

The accessible URL of the generated file.

http://xxx

Result examples

Cover

Example: [{"Score":8.270855992569906,"Time":"28278.25","Url":"cover/test-00001.jpg"},{"Score":7.474117489692728,"Time":"25942.583333333332","Url":"cover/test-00002.jpg"}]

Score is the confidence, Time is the timestamp, and Url is the file path.

VideoClip

Example: {"VideoSummaryList":[{"EndTime":"5.28","StartTime":"0.28"}]}

VideoSummaryList is a list of time ranges clipped from the source video, in seconds.

VideoDelogo

Example: {}

The output contains no additional information.

VideoDetext

Example: {}

The output contains no additional information.

CaptionExtraction

Example: {}

The output contains no additional information.

VideoGreenScreenMatting

Example: {}

The output contains no additional information.

FaceBeauty

Example: {}

The output contains no additional information.

VideoH2V

Example: {}

The output contains no additional information.

MusicSegmentDetect

Example: [{"start":39.32,"end":63.85,"title":"Chorus"},{"start":86.69,"end":114.45,"title":"Chorus"},{"start":135.75,"end":160.27,"title":"Chorus"}]

AudioBeatDetection

Example: {}

The output contains no additional information.

AudioQualityAssessment

Example: [{ "Discontinuity":"Good", "Loudness":"Excellent", "Worst MOS(0-5)":"0.38", "Discontinuity(0-5)":"3.52", "Speech Ratio":"48.55", "Loudness(0-5)":"4.91", "Worst Discontinuity(0-5)":"0.88", "Worst Coloration(0-5)":"0.42", "Channel":"1", "Coloration(0-5)":"0.99", "Bad Mute Ratio(%)":"0.0", "Time":"2022-12-02 16:14:06", "Noisiness(0-5)":"3.28", "MOS":"Poor", "Worst Noisiness(0-5)":"0.91", "Double Talk Ratio(%)":"19.23", "Input":"/home/admin/algo/quality****/example.wav", "Total Duration":"42.78", "Noisiness":"Good", "Tag":"Valid", "MOS(0-5)":"1.01", "Loudness(-90dB-0dB)":"-0.59", "Coloration":"Bad", "Saturated Ratio(%)":"37.55" }, { "Discontinuity":"Fair", "Loudness":"Excellent", "Worst MOS(0-5)":"0.65", "Discontinuity(0-5)":"2.45", "Speech Ratio":"41.68", "Loudness(0-5)":"4.52", "Worst Discontinuity(0-5)":"0.66", "Worst Coloration(0-5)":"0.72", "Channel":"2", "Coloration(0-5)":"2.34", "Bad Mute Ratio(%)":"0.0", "Time":"2022-12-02 16:14:06", "Noisiness(0-5)":"2.53", "MOS":"Poor", "Worst Noisiness(0-5)":"0.67", "Double Talk Ratio(%)":"25.93", "Input":"/home/admin/algo/quality****/example.wav", "Total Duration":"42.78", "Noisiness":"Fair", "Tag":"Valid", "MOS(0-5)":"1.69", "Loudness(-90dB-0dB)":"-4.82", "Coloration":"Fair", "Saturated Ratio(%)":"0.0" }]

Parameter descriptions

SpeechDenoise

Example: {}

The output contains no additional information.

AudioMixing

Example: {}

The output contains no additional information.

MusicDemix

Example: {}

The output contains no additional information.

Examples

Success response

JSON format

{
  "RequestId": "",
  "JobId": "****20b48fb04483915d4f2cd8ac****",
  "Name": "测试任务",
  "FunctionName": "Cover",
  "Input": {
    "Type": "OSS",
    "Media": "oss://bucket/object"
  },
  "Output": {
    "Type": "OSS",
    "Biz": "IMS",
    "Media": "oss://bucket/object",
    "OutputUrl": "http(s)://bucket.oss-[RegionId].aliyuncs.com/object "
  },
  "TemplateId": "****96e8864746a0b6f3****",
  "JobParams": "{\"Model\":\"gif\"}",
  "ScheduleConfig": {
    "PipelineId": "a54fdc9c9aab413caef0d1150f565e86",
    "Priority": 6
  },
  "UserData": "{\"test\":1}",
  "Result": "{}",
  "CreateTime": "2022-07-07T07:16:11Z",
  "FinishTime": "2021-11-26T14:50:25Z",
  "Status": "Success",
  "OutputFiles": [
    "output/xxx.mp4"
  ],
  "OutputMediaIds": [
    ""
  ],
  "OutputUrls": [
    "http://xxx"
  ]
}

Error codes

HTTP status code

Error code

Error message

Description
400 IdempotentParameterMismatch The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.