提交任务

最近更新时间：2024-04-03 16:01:45
我的收藏
本页目录：

功能描述
提交一个视频人像抠图任务。
﻿
授权说明
授权策略中 action 设置为 ci:CreateBodyJointsDetectJob 。查看所有 action。
子账号使用异步处理接口时，需要授予 cam:passrole 权限，异步处理接口会通过 CAM 的“角色”进行 COS 的资源读写操作，PassRole 权限用于传递角色。
服务开通
使用该功能需提前开通数据万象，并绑定存储桶。详情请参见 绑定存储桶。
使用该功能需提前通过控制台或接口开通 AI 内容识别服务 。详情请参见 开通 AI 内容识别服务。
使用限制
使用该接口时，请先确认相关限制条件。详情请参见 使用限制。
费用说明
该接口为付费服务，产生的费用将由数据万象收取，详细计费说明可参见 内容识别费用。
请求
请求示例
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>
说明
Authorization: Auth String（详情请参见 请求签名 文档）。
通过子账号使用时，需要授予相关的权限，详情请参见 授权粒度详情 文档。
请求头
此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。
请求体
该请求操作的实现需要有如下请求体。
<Request>
    <Tag>SegmentVideoBody</Tag>
    <Input>
        <Object>input/test.mp4</Object>
    </Input>
    <Operation>
        <SegmentVideoBody>
            <Mode>Mask</Mode>
        </SegmentVideoBody>
        <UserData>This is my data.</UserData>
        <JobLevel>0</JobLevel>
        <Output>
            <Region>ap-chongqing</Region>
            <Bucket>test-123456789</Bucket>
            <Object>output/out.mp4</Object>
        </Output>
    </Operation>
    <CallBack>http://callback.demo.com</CallBack>
    <CallBackFormat>JSON<CallBackFormat>
</Request>
具体的数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Request
无
保存请求的容器
Container
是
Container 类型 Request 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Tag
Request
创建任务的 Tag：SegmentVideoBody
String
是
Input
Request
待操作的对象信息
Container
是
Operation
Request
操作规则
Container
是
CallBackFormat
Request
任务回调格式，JSON 或 XML，默认 XML，优先级高于队列的回调格式
String
否
CallBackType
Request
任务回调类型，Url 或 TDMQ，默认 Url，优先级高于队列的回调类型
String
否
CallBack
Request
任务回调地址，优先级高于队列的回调地址。设置为 no 时，表示队列的回调地址不产生回调
String
否
CallBackMqConfig
Request
任务回调 TDMQ 配置，当 CallBackType 为 TDMQ 时必填。详情见 CallBackMqConfig
Container
否
Container 类型 Input 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Object
Request.Input
文件路径
String
是
Container 类型 Operation
 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
SegmentVideoBody
Request.Operation
视频人像抠图配置
Container
否
Output
Request.Operation
结果输出配置
Container
是
UserData
Request.Operation
透传用户信息，可打印的 ASCII 码，长度不超过1024
String
否
JobLevel
Request.Operation
任务优先级，级别限制：0 、1 、2。级别越大任务优先级越高，默认为0
String
否
Container 类型 SegmentVideoBody 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Mode
Request.Operation.SegmentVideoBody
抠图模式
 Mask：输出alpha通道结果
Foreground：输出前景视频
Combination：输出抠图后的前景与自定义背景合成后的视频
默认值：Mask
String
否
SegmentType
Request.Operation.SegmentVideoBody
抠图类型
HumanSeg：人像抠图
GreenScreenSeg：绿幕抠图
SolidColorSeg：纯色背景抠图
默认值：HumanSeg
String
否
BackgroundRed
Request.Operation.SegmentVideoBody
mode为 Foreground 时参数生效，背景颜色为红色，取值范围 [0, 255]， 默认值为 0
String
否
BackgroundGreen
Request.Operation.SegmentVideoBody
mode为 Foreground 时参数生效，背景颜色为绿色，取值范围 [0, 255]，默认值为 0
String
否
BackgroundBlue
Request.Operation.SegmentVideoBody
mode为 Foreground 时参数生效，背景颜色为蓝色，取值范围 [0, 255]，默认值为 0
String
否
BackgroundLogoUrl
Request.Operation.SegmentVideoBody
传入背景文件。mode为 Combination 时，此参数必填，背景文件需与源文件在同存储桶下
String
否
BinaryThreshold
Request.Operation.SegmentVideoBody
调整抠图的边缘位置，取值范围为[0, 255]，默认值为 0
String
否
RemoveRed
Request.Operation.SegmentVideoBody
纯色背景抠图的背景色（红）, 当 SegmentType 为 SolidColorSeg 生效，取值范围为 [0, 255]，默认值为 0
String
否
RemoveGreen
Request.Operation.SegmentVideoBody
纯色背景抠图的背景色（绿）, 当 SegmentType 为 SolidColorSeg 生效，取值范围为 [0, 255]，默认值为 0
String
否
RemoveBlue
Request.Operation.SegmentVideoBody
纯色背景抠图的背景色（蓝）, 当 SegmentType 为 SolidColorSeg 生效，取值范围为 [0, 255]，默认值为 0
String
否
Container 类型 Output 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Region
Request.Operation.Output
存储桶的地域
String
是
Bucket
Request.Operation.Output
存储结果的存储桶
String
是
Object
Request.Operation.Output
输出结果的文件名
String
是
响应
响应头
此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。
响应体
该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
<Response>
    <JobsDetail>
        <Code>Success</Code>
        <Message/>
        <JobId>ac7c990a00bf211ed946af9e0691f2b7a</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T14:44:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>pcd463e1467964d39ad2d3f66aacd8199</QueueId>
        <Tag>SegmentVideoBody</Tag>
        <Input>
            <BucketId>test-123456789</BucketId>
            <Object>input/test.mp4</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <Operation>
            <SegmentVideoBody>
                <Mode>Mask</Mode>
            </SegmentVideoBody>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/out.mp4</Object>
            </Output>
        </Operation>
    </JobsDetail>
</Response>
具体的数据内容如下：
节点名称（关键字）
父节点
描述
类型
Response
无
保存结果的容器
Container
Container 节点 Response 的内容：
节点名称（关键字）
父节点
描述
类型
JobsDetail
Response
任务的详细信息
Container 数组
Container 节点 JobsDetail
 的内容：
节点名称（关键字）
父节点
描述
类型
Code
Response.JobsDetail
错误码，只有 State 为 Failed 时有意义
String
Message
Response.JobsDetail
错误描述，只有 State 为 Failed 时有意义
String
JobId
Response.JobsDetail
创建任务的 ID
String
Tag
Response.JobsDetail
创建任务的 Tag：SegmentVideoBody
String
State
Response.JobsDetail
任务状态
Submitted：已提交，待执行
Running：执行中
Success：执行成功
Failed：执行失败
Pause：任务暂停，当暂停队列时，待执行的任务会变为暂停状态
Cancel：任务被取消执行
String
CreationTime
Response.JobsDetail
任务的创建时间
String
StartTime
Response.JobsDetail
任务的开始时间
String
EndTime
Response.JobsDetail
任务的结束时间
String
QueueId
Response.JobsDetail
任务所属的 队列 ID﻿
String
Input
Response.JobsDetail
同请求中的 Request.Input 节点
Container
Operation
Response.JobsDetail
该任务的规则
Container
Container 节点 Operation 的内容：
节点名称（关键字）
父节点
描述
类型
SegmentVideoBody
Response.JobsDetail.Operation
同请求中的 Request.Operation.SegmentVideoBody
Container
Output
Response.JobsDetail.Operation
同请求中的 Request.Operation.Output
Container
UserData
Response.JobsDetail.Operation
透传用户信息
String
JobLevel
Response.JobsDetail.Operation
任务优先级
String
MediaInfo
Response.JobsDetail.Operation
输出文件的媒体信息，任务未完成时不返回，详见 MediaInfo﻿
Container
MediaResult
Response.JobsDetail.Operation
输出文件的基本信息，任务未完成时不返回，详见 MediaResult﻿
Container
错误码
该请求操作无特殊错误信息，常见的错误信息请参见 错误码 文档。
实际案例
请求
POST /jobs HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057
Host: test-1234567890.ci.ap-beijing.myqcloud.com
Content-Length: 166
Content-Type: application/xml
﻿
<Request>
    <Tag>SegmentVideoBody</Tag>
    <Input>
        <Object>input/test.mp4</Object>
    </Input>
    <Operation>
        <SegmentVideoBody>
            <Mode>Mask</Mode>
        </SegmentVideoBody>
        <UserData>This is my data.</UserData>
        <JobLevel>0</JobLevel>
        <Output>
            <Region>ap-chongqing</Region>
            <Bucket>test-123456789</Bucket>
            <Object>output/out.mp4</Object>
        </Output>
    </Operation>
    <CallBack>http://callback.demo.com</CallBack>
    <CallBackFormat>JSON<CallBackFormat>
</Request>
响应
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>ac7c990a00bf211ed946af9e0691f2b7a</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T14:44:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>pcd463e1467964d39ad2d3f66aacd8199</QueueId>
        <Tag>SegmentVideoBody</Tag>
        <Input>
            <BucketId>test-123456789</BucketId>
            <Object>input/test.mp4</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <Operation>
            <SegmentVideoBody>
                <Mode>Mask</Mode>
            </SegmentVideoBody>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/out.mp4</Object>
            </Output>
        </Operation>
    </JobsDetail>
</Response>
﻿
节点名称（关键字）	父节点	描述	类型	是否必选
Request	无	保存请求的容器	Container	是