All Products
Search

This Product

    Intelligent Media Services:QueryIProductionJob

    Document Center

    Intelligent Media Services:QueryIProductionJob

    Last Updated:Dec 16, 2024

    Queries the status and result of an intelligent production job.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    ice:QueryIProductionJob
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request.

    JobIdstringYes

    The ID of the intelligent production job.

    		****20b48fb04483915d4f2cd8ac****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The schema of the response.

    RequestIdstring

    The ID of the request.

    JobIdstring

    The ID of the intelligent production job.

    		****20b48fb04483915d4f2cd8ac****
    Namestring

    The name of the intelligent production job.

    FunctionNamestring

    The name of the algorithm that you want to use for the job. Valid values:

    • Cover: This algorithm intelligently generates a thumbnail image for a video.
    • VideoClip: This algorithm intelligently generates a summary for a video.
    • VideoDelogo: This algorithm removes logos from a video.
    • VideoDetext: This algorithm removes captions from a video.
    		Cover
    Inputobject

    The input file.

    Typestring

    The media type. Valid values:

    1. OSS: Object Storage Service (OSS) object
    2. Media: media asset
    		OSS
    Mediastring

    The input file. If Type is set to OSS, set this parameter to the path of an OSS object. If Type is set to Media, set this parameter to the ID of a media asset. You can specify the path of an OSS object in one of the following formats:

    1. oss://bucket/object
    2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object bucket in the path specifies an OSS bucket that resides in the same region as the intelligent production job. object in the path specifies the object path in OSS.
    		oss://bucket/object
    Outputobject

    The output file.

    Typestring

    The media type. Valid values:

    • OSS: OSS object
    • Media: media asset
    		OSS
    Mediastring

    The output file. If Type is set to OSS, set this parameter to the path of an OSS object. If Type is set to Media, set this parameter to the ID of a media asset. You can specify the path of an OSS object in one of the following formats:

    1. oss://bucket/object
    2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object bucket in the path specifies an OSS bucket that resides in the same region as the intelligent production job. object in the path specifies the object path in OSS.
    		oss://bucket/object
    TemplateIdstring

    The template ID.

    		****96e8864746a0b6f3****
    JobParamsstring

    The algorithm-specific parameters. The parameters are specified as JSON objects and vary based on the algorithm.

    		{"Model":"gif"}
    ScheduleConfigobject

    The scheduling configuration.

    PipelineIdstring

    The ID of the ApsaraVideo Media Processing (MPS) queue.

    		a54fdc9c9aab413caef0d1150f565e86
    Priorityinteger

    The priority of the job in the MPS queue to which the job is added.

    • A value of 10 indicates the highest priority.
    • Default value: 6.
    		6
    UserDatastring

    The user-defined data that is returned in the response.

    		{"test":1}
    Resultstring

    The output of the algorithm. The output is in JSON format and varies based on the algorithm. For more information, see the "Parameters of Result" section of this topic.

    		{}
    CreateTimestring

    The time when the job was created.

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

    The time when the job was complete.

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

    The status of the job. Valid values:

    • Queuing: The job is waiting in the queue.
    • Analysing: The job is in progress.
    • Fail: The job failed.
    • Success: The job was successful.
    		Success
    OutputFilesarray

    The output files.

    OutputFilestring

    The path and name of the output file.

    		output/xxx.mp4
    OutputUrlsarray

    The URLs of the output files.

    OutputUrlstring

    The URL of the output file.

    		http://xxx

    Parameters of Result

    Cover

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

    The Score parameter indicates the confidence score of the thumbnail image. The Time parameter indicates the timestamp of the thumbnail frame. The Url parameter indicates the path of the thumbnail image.

    VideoClip

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

    The VideoSummaryList parameter indicates a list of the time ranges that are captured from the original video. Unit: seconds.

    Example: {}

    This algorithm does not return additional information.

    VideoDetext

    Example: {}

    This algorithm does not return additional information.

    CaptionExtraction

    Example: {}

    This algorithm does not return additional information.

    VideoGreenScreenMatting

    Example: {}

    This algorithm does not return additional information.

    FaceBeauty

    Example: {}

    This algorithm does not return additional information.

    VideoH2V

    Example: {}

    This algorithm does not return 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: {}

    This algorithm does not return 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" }]

    For more information, see the "AudioQualityAssessment" section of the Parameters for intelligent production API operations topic.

    SpeechDenoise

    Example: {}

    This algorithm does not return additional information.

    AudioMixing

    Example: {}

    This algorithm does not return additional information.

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "",
  "JobId": "****20b48fb04483915d4f2cd8ac****",
  "Name": "",
  "FunctionName": "Cover",
  "Input": {
    "Type": "OSS",
    "Media": "oss://bucket/object"
  },
  "Output": {
    "Type": "OSS",
    "Media": "oss://bucket/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"
  ],
  "OutputUrls": [
    "http://xxx"
  ]
}

    Error codes

    HTTP status codeError codeError message
    400IdempotentParameterMismatchThe 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.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2022-07-13Add OperationView Change Details