数据万象
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>数据万象>API 文档>AI 内容识别>视频目标检测>创建模板

创建模板

最近更新时间：2024-11-05 19:49:02

我的收藏

本页目录：

功能描述

创建视频目标检测模板。

授权说明

通过子账号使用时，需要授予 ci:CreateMediaTemplate权限，详情请参见 数据万象 action。

服务开通

使用该功能需提前开通数据万象，并绑定存储桶。详情请参见 绑定存储桶。
使用该功能需提前通过控制台或接口开通 AI 内容识别服务 。详情请参见 开通 AI 内容识别服务。

使用限制

使用该接口时，请先确认相关限制条件。详情请参见 使用限制。


请求

请求示例

POST /template 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>VideoTargetRec</Tag>
    <Name>TemplateName</Name>
    <VideoTargetRec>
        <Body>true</Body>
        <Pet>false</Pet>
        <Car>true</Car>
    </VideoTargetRec>
</Request>
具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Request
无
保存请求的容器
Container
是
Container 类型
Request
的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Tag
Request
模板类型：VideoTargetRec
String
是
Name
Request
模板名称，仅支持中文、英文、数字、_、-和*，长度不超过 64
String
是
VideoTargetRec
Request
视频目标检测 参数
Container
是
Container 类型
VideoTargetRec
的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
默认值
可选值
Body
Request.VideoTargetRec
是否开启人体检测
string
否
false
true/false
Pet
Request.VideoTargetRec
是否开启宠物检测
string
否
false
true/false
Car
Request.VideoTargetRec
是否开启车辆检测
string
否
false
true/false
Plate
Request.VideoTargetRec
是否开启车牌检测
string
否
false
true/false
Face
Request.VideoTargetRec
是否开启人脸检测
string
否
false
true/false
SnapshotFreq
Request.VideoTargetRec
检测频率，[0,30]区间的浮点数
string
否
1
[0,30]
ProcessType
Request.VideoTargetRec
处理方式，该参数为空时表示仅进行检测并返回信息；该参数不为空则标识开启检测后处理，支持马赛克类型，只有 Face、Plate 两种检测支持检测后处理
string
否
Mosaic
Mosaic
TransTpl
Request.VideoTargetRec
识别后处理参数，当 ProcessType 不为空时生效且必填
Container
否
无
无
说明:
Body、Pet、Car 不能同时为 false。
开启检测后处理即 ProcessType 不为空时，Body、Pet、Car 不能为 true 。
Container 类型 TransTpl 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
默认值
限制
Container
Request.VideoTargetRec.TransTpl
封装格式
string
是
无
无
Codec
Request.VideoTargetRec.TransTpl
编解码格式
string
否
无
H.264、H.265
Bitrate
Request.VideoTargetRec.TransTpl
视频码率
string
否
视频原始码率
值范围：[10，50000]
单位：Kbps
Crf
Request.VideoTargetRec.TransTpl
码率-质量控制因子
string
否
无
值范围：(0, 51]
如果设置了 Crf，则 Bitrate 的设置失效
当 Bitrate 为空时，默认为25
Width
Request.VideoTargetRec.TransTpl
宽
string
否
无
值范围：[128，4096]
单位：px
若只设置 Width 时，按照视频原始比例计算 Height
Height
Request.VideoTargetRec.TransTpl
高
string
否
无
值范围：[128，4096]
单位：px
若只设置 Height 时，按照视频原始比例计算 Width
Fps
Request.VideoTargetRec.TransTpl
帧率
string
否
视频原始帧率
值范围：(0，60]
单位：fps
Container 类型 Container 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Format
Request.Container
封装格式：支持 mp4，flv，mkv，hls，ts，avi，mov
String
是
ClipConfig
Request.Container
分片配置，当 format 为 hls 时有效
Container
否
Container 类型 ClipConfig 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Duration
Request.Container.ClipConfig
分片时长，默认5s
String
否

响应

响应头

此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。

响应体

该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
<Response>
    <RequestId>NjQ0NGNlNDZfMThhYTk0MGFfY*********</RequestId>
    <Template>
        <Tag>VideoTargetRec</Tag>
        <Name>TemplateName</Name>
        <State>Normal</State>
        <Tag>VideoTargetRec</Tag>
        <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
        <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
        <BucketId>test-1234567890</BucketId>
        <Category>Custom</Category>
        <VideoTargetRec>
            <Body>true</Body>
            <Pet>false</Pet>
            <Car>true</Car>
        </VideoTargetRec>
    </Template>
</Response>
具体的数据内容如下：
节点名称（关键字）
父节点
描述
类型
Response
无
保存结果的容器
Container
Container 节点
Response
的内容：
节点名称（关键字）
父节点
描述
类型
RequestId
Response
请求的唯一 ID
String
Template
Response
保存模板详情的容器
Container
Container 节点
Template
的内容：
节点名称（关键字）
父节点
描述
类型
TemplateId
Response.Template
模板 ID
String
Name
Response.Template
模板名称
String
BucketId
Response.Template
模板所属存储桶
String
Category
Response.Template
模板属性，Custom 或者 Official
String
Tag
Response.Template
模板类型，VideoTargetRec
String
UpdateTime
Response.Template
更新时间
String
CreateTime
Response.Template
创建时间
String
VideoTargetRec
Response.Template
同请求体中的 Request.VideoTargetRec
Container

错误码

该请求操作无特殊错误信息，常见的错误信息请参见 错误码 文档。

实际案例

请求

POST /template 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: 1666
Content-Type: application/xml

<Request>
    <Tag>VideoTargetRec</Tag>
    <Name>TemplateName</Name>
    <VideoTargetRec>
        <Body>true</Body>
        <Pet>false</Pet>
        <Car>true</Car>
    </VideoTargetRec>
</Request>

响应

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 14 Jul 2022 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
    <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
    <Template>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <Name>TemplateName</Name>
        <State>Normal</State>
        <Tag>VideoTargetRec</Tag>
        <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
        <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
        <BucketId>test-1234567890</BucketId>
        <Category>Custom</Category>
        <VideoTargetRec>
            <Body>true</Body>
            <Pet>false</Pet>
            <Car>true</Car>
        </VideoTargetRec>
    </Template>
</Response>
中国站
文档反馈
文档活动
message-icon联系我们
目录