功能描述
提交一个视频目标检测任务。
授权说明
通过子账号使用时,需要授予
ci:CreateMediaJobs
权限,详情请参见 数据万象 action。子账号使用异步处理接口时,需要授予
cam:passrole
权限,异步处理接口会通过 CAM 的“角色”进行 COS 的资源读写操作,PassRole 权限用于传递角色, 具体请查看 访问管理-写操作-PassRole 接口。服务开通
使用该功能需提前开通数据万象,并绑定存储桶。详情请参见 绑定存储桶。
使用该功能需提前通过控制台或接口开通 AI 内容识别服务 。详情请参见 开通 AI 内容识别服务。
使用限制
费用说明
请求
请求示例
POST /jobs HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml<body>
说明
请求头
请求体
该请求操作的实现需要有如下请求体:
<Request><Tag>VideoTargetRec</Tag><Input><Object>input/demo.mp4</Object></Input><Operation><TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON<CallBackFormat></Request>
具体的数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Request | 无 | 保存请求的容器 | Container | 是 |
Container 类型 Request 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Tag | Request | 创建任务的 Tag:VideoTargetRec | String | 是 |
Operation | Request | 操作规则 | Container | 是 |
Input | Request | 待操作的媒体信息 | Container | 是 |
CallBackFormat | Request | 任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式 | String | 否 |
CallBackType | Request | 任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型 | String | 否 |
CallBack | Request | 任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调 | String | 否 |
CallBackMqConfig | Request | Container | 否 |
Container 类型 Input 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Object | Request.Input | 媒体文件名 | String | 否 |
Container 类型
Operation
的具体数据描述如下:节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
TemplateId | Request.Operation | 视频目标检测模板 ID | String | 否 |
VideoTargetRec | Request.Operation | Container | 否 | |
UserData | Request.Operation | 透传用户信息, 可打印的 ASCII 码, 长度不超过1024 | String | 否 |
JobLevel | Request.Operation | 任务优先级,级别限制:0 、1 、2 。级别越大任务优先级越高,默认为0 | String | 否 |
SnapshotPrefix | Request.Operation | 截图输出前缀。配置后,截图输出到用户桶,路径为 "SnapshotPrefix/<jobId>/<随机的截图名>",会额外产生费用。为空时不保存截图 | String | 否 |
注意
视频目标检测参数必须设置,可以通过 TemplateId 或 VideoTargetRec 设置,TemplateId 优先级更高。
响应
响应头
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response><JobsDetail><Code>Success</Code><Message/><JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId><State>Submitted</State><CreationTime>2022-06-27T15:23:10+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><Tag>VideoTargetRec</Tag><Operation><TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId><TemplateName>video_target_rec_demo</TemplateName><UserData>This is my data.</UserData><JobLevel>0</JobLevel></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:VideoTargetRec | 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 |
Operation | Response.JobsDetail | 该任务的规则 | Container |
Container 节点 Operation 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
TemplateId | Response.JobsDetail.Operation | 任务的模板 ID | String |
TemplateName | Response.JobsDetail.Operation | 任务的模板名称, 当 TemplateId 存在时返回 | String |
VideoTargetRec | Response.JobsDetail.Operation | 同请求中的 Request.Operation.VideoTargetRec | Container |
VideoTargetRecResult | Response.JobsDetail.Operation | 视频目标检测结果 | Container |
UserData | Response.JobsDetail.Operation | 透传用户信息 | String |
JobLevel | Response.JobsDetail.Operation | 任务优先级 | String |
Container 节点 VideoTargetRecResult 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
BodyRecognition | Response.JobsDetail.Operation.VideoTargetRecResult | 人体识别结果 | Container 数组 |
PetRecognition | Response.JobsDetail.Operation.VideoTargetRecResult | 宠物识别结果 | Container 数组 |
CarRecognition | Response.JobsDetail.Operation.VideoTargetRecResult | 车辆识别结果 | Container 数组 |
Container 节点 BodyRecognition 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Time | Response.JobsDetail.Operation.VideoTargetRecResult.BodyRecognition | 截图的时间点,单位为秒 | String |
Url | Response.JobsDetail.Operation.VideoTargetRecResult.BodyRecognition | 截图 URL | String |
BodyInfo | Response.JobsDetail.Operation.VideoTargetRecResult.BodyRecognition | 人体识别结果,可能有多个 | Container 数组 |
Container 节点 PetRecognition 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Time | Response.JobsDetail.Operation.VideoTargetRecResult.PetRecognition | 截图的时间点,单位为秒 | String |
Url | Response.JobsDetail.Operation.VideoTargetRecResult.PetRecognition | 截图 URL | String |
PetInfo | Response.JobsDetail.Operation.VideoTargetRecResult.PetRecognition | 宠物识别结果结果,可能有多个 | Container 数组 |
Container 节点 CarRecognition 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Time | Response.JobsDetail.Operation.VideoTargetRecResult.CarRecognition | 截图的时间点,单位为秒 | String |
Url | Response.JobsDetail.Operation.VideoTargetRecResult.CarRecognition | 截图 URL | String |
CarInfo | Response.JobsDetail.Operation.VideoTargetRecResult.CarRecognition | 车辆识别结果,可能有多个 | Container 数组 |
Container 节点 BodyInfo 节点的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Name | Response.JobsDetail.Operation.VideoTargetRecResult.BodyRecognition.BodyInfo | 识别类型 | String |
Score | Response.JobsDetail.Operation.VideoTargetRecResult.BodyRecognition.BodyInfo | 识别的置信度,取值范围为[0-100]。值越高概率越大。 | Int |
Location | Response.JobsDetail.Operation.VideoTargetRecResult.BodyRecognition.BodyInfo | 图中识别到人体的坐标 | Container |
Container 节点 Location 节点的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
X | Response.JobsDetail.Operation.VideoTargetRecResult.BodyRecognition.BodyInfo.Location | X坐标 | String |
Y | Response.JobsDetail.Operation.VideoTargetRecResult.BodyRecognition.BodyInfo.Location | Y坐标 | String |
Height | Response.JobsDetail.Operation.VideoTargetRecResult.BodyRecognition.BodyInfo.Location | (X,Y)坐标距离高度 | String |
Width | Response.JobsDetail.Operation.VideoTargetRecResult.BodyRecognition.BodyInfo.Location | (X,Y)坐标距离长度 | String |
Container 节点 PetInfo 节点的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Name | Response.JobsDetail.Operation.VideoTargetRecResult.PetRecognition.PetInfo | 识别类型 | String |
Score | Response.JobsDetail.Operation.VideoTargetRecResult.PetRecognition.PetInfo | 识别的置信度,取值范围为[0-100]。值越高概率越大。 | Int |
Location | Response.JobsDetail.Operation.VideoTargetRecResult.PetRecognition.PetInfo | 图中识别到宠物的坐标 | Container |
Container 节点 Location 节点的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
X | Response.JobsDetail.Operation.VideoTargetRecResult.PetRecognition.PetInfo.Location | X坐标 | Int |
Y | Response.JobsDetail.Operation.VideoTargetRecResult.PetRecognition.PetInfo.Location | Y坐标 | Int |
Height | Response.JobsDetail.Operation.VideoTargetRecResult.PetRecognition.PetInfo.Location | (X,Y)坐标距离高度 | Int |
Width | Response.JobsDetail.Operation.VideoTargetRecResult.PetRecognition.PetInfo.Location | (X,Y)坐标距离长度 | Int |
Container 节点 CarInfo 节点的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Name | Response.JobsDetail.Operation.VideoTargetRecResult.CarRecognition.CarInfo | 识别类型 | String |
Score | Response.JobsDetail.Operation.VideoTargetRecResult.CarRecognition.CarInfo | 识别的置信度,取值范围为[0-100]。值越高概率越大。 | Int |
Location | Response.JobsDetail.Operation.VideoTargetRecResult.CarRecognition.CarInfo | 图中识别到车辆的坐标 | Container |
Container 节点 Location 节点的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
X | Response.JobsDetail.Operation.VideoTargetRecResult.CarRecognition.CarInfo.Location | X坐标 | Int |
Y | Response.JobsDetail.Operation.VideoTargetRecResult.CarRecognition.CarInfo.Location | Y坐标 | Int |
Height | Response.JobsDetail.Operation.VideoTargetRecResult.CarRecognition.CarInfo.Location | (X,Y)坐标距离高度 | Int |
Width | Response.JobsDetail.Operation.VideoTargetRecResult.CarRecognition.CarInfo.Location | (X,Y)坐标距离长度 | Int |
错误码
实际案例
请求1:使用视频目标检测模板 ID
POST /jobs HTTP/1.1Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0**********&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057Host:test-1234567890.ci.ap-chongqing.myqcloud.comContent-Length: 166Content-Type: application/xml<Request><Tag>VideoTargetRec</Tag><Input><Object>input/demo.mp4</Object></Input><Operation><TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON<CallBackFormat></Request>
响应1
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 230Connection: keep-aliveDate: Mon, 28 Jun 2022 15:23:12 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response><JobsDetail><Code>Success</Code><Message/><JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId><State>Submitted</State><CreationTime>2022-06-27T15:23:10+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><Tag>VideoTargetRec</Tag><Operation><TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId><TemplateName>video_target_rec_demo</TemplateName><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>
请求2:使用视频目标检测处理参数
POST /jobs HTTP/1.1Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0**********&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057Host:test-1234567890.ci.ap-chongqing.myqcloud.comContent-Length: 166Content-Type: application/xml<Request><Tag>VideoTargetRec</Tag><Input><Object>input/demo.mp4</Object></Input><Operation><VideoTargetRec><Body>true</Body><Car>true</Car><Pet>true</Pet></VideoTargetRec><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON<CallBackFormat></Request>
响应2
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 230Connection: keep-aliveDate: Mon, 28 Jun 2022 15:23:12 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response><JobsDetail><Code>Success</Code><Message/><JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId><State>Submitted</State><CreationTime>2022-06-27T15:23:10+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><Tag>VideoTargetRec</Tag><Operation><VideoTargetRec><Body>true</Body><Car>true</Car><Pet>true</Pet></VideoTargetRec><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>