tencent cloud

Submitting Tasks
Download PDF
Last updated: 2025-11-19 11:52:51
Submitting Tasks
Last updated: 2025-11-19 11:52:51
Download PDF

Feature Description

Submit a video quality analysis task.

Authorization Description

When using with a sub-account, the ci:CreateMediaJobs permission is required. For details, see Cloud Infinite actions.
When a sub-account uses an asynchronous processing interface, the cam:passrole permission is required. The asynchronous processing interface performs COS resource read and write operations through CAM's "role". PassRole permission is used for role passing. For details, refer to Access Management > Write Operation > PassRole API.

Activating a Service

Using this feature requires enabling Cloud Infinite in advance and binding a bucket. For details, see Bind Bucket.
Use this feature requires enabling Media Processing Service in advance via console or API. For details, see Enable Media Processing Service.

Use Limits

When using this API, please first confirm the relevant restrictions. For details, see Usage Limits.

Fee Description

This interface is a paid service. Generated costs will be charged by Cloud Infinite. For detailed billing instructions, see Media Processing Fees.


Request

Request sample

POST /jobs HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml

<body>
Note:
Authorization: Auth String. For details, see Request Signature document.

Request header.

This API only uses common request headers. For details, see Common Request Headers documentation.

Request body.

The implementation of this request operation requires the following request body:
<Request>
    <Tag>QualityEstimate</Tag>
    <Input>
        <Object>input/demo.mp4</Object>
    </Input>
    <Operation>
        <QualityEstimateConfig>
            <Rotate>90</Rotate>
            <Mode>vqaPlus</Mode>
        </QualityEstimateConfig>
        <UserData>This is my data.</UserData>
        <JobLevel>0</JobLevel>
    </Operation>
    <CallBack>http://callback.demo.com</CallBack>
    <CallBackFormat>JSON</CallBackFormat>
</Request>
The data are described as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Request
None.
Container for saving requests
Container
Yes
The specific data description of the Container type Request is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Tag
Request
Create task Tag: QualityEstimate
String
Yes
Input
Request
File information to be operated
Container
Yes
Operation
Request
Operation rule
Container
No
CallBackFormat
Request
job callback format, JSON or XML, default XML, priority is higher than the callback format of the queue
String
No
CallBackType
Request
job callback type, Url or TDMQ, default Url, priority is higher than the callback type of the queue
String
No
CallBack
Request
job callback address, priority is higher than the queue's callback address. When set to no, it means the queue's callback address does not generate callbacks.
String
No
CallBackMqConfig
Request
task callback TDMQ configuration, required when CallBackType is TDMQ. For details, see CallBackMqConfig
Container
No
The specific data description of the Container type Input is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Object
Request.Input
file path
String
Yes
The specific data description of the Container type
Operation
is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
QualityEstimateConfig
Request.Operation
Quality scoring configuration
Container
No
UserData
Request.Operation
Pass through user information Printable ASCII code Length not exceeding 1024
String
No
JobLevel
Request.Operation
Task priority, level limit: 0, 1, 2. Higher levels indicate higher task priority. Default is 0.
String
No
The specific data description of the Container type
Operation
is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Default Value
Required or Not
Rotate
Request.Operation.QualityEstimateConfig
Rotation angle, supports only 0, 90, 180, 270
String
0
No
Mode
Request.Operation.QualityEstimateConfig
Analysis mode
general: general analysis, only return video quality score
vqaPlus: return more detailed analysis results
When set to vqaPlus, the Rotate parameter is invalid.
String
general
No

Response

Response Headers

This API only returns the public response header. For details, see Common Response Headers documentation.

Response Body

The response body is returned as application/xml. An example including the complete node data is shown below:
<Response>
    <JobsDetail>
        <Code>Success</Code>
        <Message/>
        <JobId>j229ed9e2f60c11ec8525e36307395bf9</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <Tag>QualityEstimate</Tag>
        <Input>
            <BucketId>test-123456789</BucketId>
            <Object>input/demo.mp4</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <Operation>
            <QualityEstimateConfig>
                <Rotate>90</Rotate>
                <Mode>vqaPlus</Mode>
            </QualityEstimateConfig>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
        </Operation>
    </JobsDetail>
</Response>
The data are as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container for saving results
Container
Container node Response content:
Node Name (Keyword)
Parent Node
Description
Type
JobsDetail
Response
Task details
Container array
The content of Container node
JobsDetail
:
Node Name (Keyword)
Parent Node
Description
Type
Code
Response.JobsDetail
Error code, meaningful only when State is Failed.
String
Message
Response.JobsDetail
Error description, meaningful only when State is Failed.
String
JobId
Response.JobsDetail
ID of the newly created task
String
Tag
Response.JobsDetail
Tag of the newly created task: QualityEstimate
String
State
Response.JobsDetail
Task Status
Submitted: submitted, pending execution
Running: executing
Success: execution successful
Failed: execution failed
Pause: task pause, when a queue is paused, to-be-executed tasks become paused state
Cancel: task cancelled
String
CreationTime
Response.JobsDetail
Task creation time
String
StartTime
Response.JobsDetail
Task Start Time
String
EndTime
Response.JobsDetail
Task End Time
String
QueueId
Response.JobsDetail
Task belongs to queue ID
String
Input
Response.JobsDetail
Input resource address of the task
Container
Operation
Response.JobsDetail
Rules of the task
Container
Contents of the Container node Input:
Node Name (Keyword)
Parent Node
Description
Type
Region
Response.JobsDetail.Input
Region of the bucket
String
Bucket
Response.JobsDetail.Input
Bucket for storing results
String
Object
Response.JobsDetail.Input
Filename of the output result
String
Contents of the Container node Operation:
Node Name (Keyword)
Parent Node
Description
Type
MediaInfo
Response.JobsDetail.Operation
Output video information. Do not return if the task is incomplete. For details, see MediaInfo.
Container
QualityEstimate
Response.JobsDetail.Operation
Video analysis result. Do not return if the task is incomplete.
Container
UserData
Response.JobsDetail.Operation
Pass through user information
String
Container node QualityEstimate content:
Node Name (Keyword)
Parent Node
Description
Type
Score
Response.JobsDetail.Operation.QualityEstimate
Video quality score, with a maximum of 10 points. A score of 6 or above can be considered good video quality.
String
VqaPlusResult
Response.JobsDetail.Operation.QualityEstimate
Analysis result when the mode is vqaPlus
Container
Container node QualityEstimate content:
Node Name (Keyword)
Parent Node
Description
Type
NoAudio
Response.JobsDetail.Operation.QualityEstimate.VqaPlusResult
No audio
bool
NoVideo
Response.JobsDetail.Operation.QualityEstimate.VqaPlusResult
No video
bool
DetailedResult
Response.JobsDetail.Operation.QualityEstimate.VqaPlusResult
detailed analysis result
Container array
Content of the Container node DetailedResult:
Node Name (Keyword)
Parent Node
Description
Type
Type
Response.JobsDetail.Operation.QualityEstimate.VqaPlusResult.DetailedResult
Exception item, value range:
Jitter
Blur: Blurry
Low lighting
HighLighting: overexposed
CrashScreen: screen glitch
BlackWhiteEdge: black and white edge
SolidColorScreen: solid color screen
Noise: Noise
Mosaic
QRCode: QR code
AppletCode: mini program code
BarCode: barcode
LowVoice: bass
HighVoice: Audio distortion
NoVoice: mute
LowEvaluation: no reference scoring below threshold
String
Items
Response.JobsDetail.Operation.QualityEstimate.VqaPlusResult.DetailedResult
Exception item information
Container array
Container node Items content:
Node Name (Keyword)
Parent Node
Description
Type
Confidence
Response.JobsDetail.Operation.QualityEstimate.VqaPlusResult.DetailedResult.Items
confidence degree, with a value range from 0 to 100. In some scenarios, this field may not be returned.
Integer
StartTimeOffset
Response.JobsDetail.Operation.QualityEstimate.VqaPlusResult.DetailedResult.Items
Occurrence start time, unit: seconds.
Float
EndTimeOffset
Response.JobsDetail.Operation.QualityEstimate.VqaPlusResult.DetailedResult.Items
Occurrence end time, unit: seconds.
Float
AreaCoordSet
Response.JobsDetail.Operation.QualityEstimate.VqaPlusResult.DetailedResult.Items
Area coordinates (px), i.e., coordinates of the top-left corner, coordinate of the bottom-right corner.
Integer array

Error Codes

This request returns common error responses and error codes. For more information, see Error Codes.

Examples

Request

POST /jobs HTTP/1.1
Authorization:q-sign-algorithm=sha1&q-ak=**********************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=**************************************
Host:test-1234567890.ci.ap-chongqing.myqcloud.com
Content-Length: 166
Content-Type: application/xml

<Request>
    <Tag>QualityEstimate</Tag>
    <Input>
        <Object>input/demo.mp4</Object>
    </Input>
    <Operation>
        <QualityEstimateConfig>
            <Rotate>90</Rotate>
            <Mode>vqaPlus</Mode>
        </QualityEstimateConfig>
        <UserData>This is my data.</UserData>
        <JobLevel>0</JobLevel>
    </Operation>
    <CallBack>http://callback.demo.com</CallBack>
    <CallBackFormat>JSON</CallBackFormat>
</Request>

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Mon, 28 Jun 2022 15:23:12 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
    <JobsDetail>
        <Code>Success</Code>
        <Message/>
        <JobId>j229ed9e2f60c11ec8525e36307395bf9</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <Tag>QualityEstimate</Tag>
        <Input>
            <BucketId>test-123456789</BucketId>
            <Object>input/demo.mp4</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <Operation>
            <QualityEstimateConfig>
                <Rotate>90</Rotate>
                <Mode>vqaPlus</Mode>
            </QualityEstimateConfig>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
        </Operation>
    </JobsDetail>
</Response>

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback