天翼云智能视图服务API

1.创建存储模板

接口功能介绍

本接口用于创建视频存储模板，支持配置录制类型、存储时长等。

接口约束

无

URI

POST /recordTemplates

路径参数
无

Query参数
无

请求参数

请求头header参数

参数	是否必填	参数类型	说明	示例
Authorization	是	String	认证信息。	CT-HMAC-SHA256 Credential=FQ01GA2RR9IJFM1PWIPR/2023-07-18/vss, SignedHeaders=content-type;host;timestamp, Signature=c6e72dffcfb2d25d276e119781e1deb6656d966702191b2bd862d1691e39394f
Content-Type	是	String	互联网媒体类型。	application/json;charset=utf-8
Host	是	String	主机。	vssapi.ctyun.cn
Version	是	String	版本。	2021-11-25
Timestamp	是	String	时间戳。	1689643309

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
TemplateName	是	String	模板名称，4-64位，可包含大小写字母、数字、中文、中划线、下划线、小括号、空格。	存储模板
FileFormat	否	String	录像文件格式，默认m3u8。取值：m3u8：符合hls协议的m3u8文件；ps：符合国标协议的ps文件。	m3u8
FileDuration	否	Integer	录像单文件时长，单位秒。	1800
RecordModes	是	Array of Objects	录制方式列表，可以配置多种录制类型。		RecordMode
Description	否	String	模板描述，长度小于等于255个字符。	描述

表 RecordMode

参数	是否必填	参数类型	说明	示例	下级对象
RecordType	是	Integer	录制类型。取值：1：全天录制；2：循环定时录制；3：指定时间录制；5：手动录制。	1
StorageTime	是	Integer	存储时长，单位秒，最小不少于30天。例：2592000表示30天。	2592000
WeekTimeSections	否	Array of Objects	定时录制的时间段，当RecordType为2时，该字段必选。		WeekTimeSection
SpecTimeSections	否	Array of Objects	指定时间录制的时间段，当RecordType为3时，该字段必选。		SpecTimeSection

表 WeekTimeSection

参数	是否必填	参数类型	说明	示例
DayofWeek	是	Integer	日期。取值：1-7（对应周一至周日）。	1
StartTime	是	String	录制开始时间，格式：HH:mm:ss，范围：[00:00:00~23:59:59]。	00:02:00
EndTime	是	String	录制结束时间，格式：HH:mm:ss，范围：[00:00:00~23:59:59]。	00:05:00

表 SpecTimeSection

参数	是否必填	参数类型	说明	示例	下级对象
StartTime	是	String	录制开始时间，格式：YYYY-DD-MM HH:mm:ss。	2021-11-25 00:02:00
EndTime	是	String	录制结束时间，格式：YYYY-DD-MM HH:mm:ss。	2021-11-26 00:05:00

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	响应状态码。	200
error	String	错误码，执行成功时，不返回该字段。	VSS_0001
message	String	响应信息。	请求成功
requestId	String	请求ID。	362d4e78556b47129182d0881fade86b
returnObj	Object	响应数据，执行失败时，不返回该字段。		returnObj

表 returnObj

参数	参数类型	说明	示例
RecordTemplateId	String	模板ID。	717074786139029504
CreatedTime	String	模板创建时间。	2023-04-25 15:15:07
UpdatedTime	String	模板更新时间。	2023-04-25 15:15:07
RequestId	String	请求ID。	a194d4c32d4d4e489f70ac9296f46c72

请求示例

请求url

POST '/recordTemplates'

请求头header

{
    "Authorization": "CT-HMAC-SHA256 Credential=SBGX5QWGRAC5QMDQUXIZ/2023-04-25/vss, SignedHeaders=content-type;host;timestamp, Signature=6c41c6674f3c6430a592f6e0ab3185fa752b895e6773c8bbf76b38e099e029fe",
    "Content-Type": "application/json;charset=utf-8",
    "Host": "vssapi.ctyun.cn",
    "Version": "2021-11-25",
    "Timestamp": "1682406354"
}

请求体body

{
  "TemplateName":"openapi-test",
  "RecordModes":[
    {
      "RecordType":1,
      "StorageTime":2592000
    }
  ]
}

响应示例

{
  "statusCode": 200,
  "message": "请求成功",
  "requestId": "a194d4c32d4d4e489f70ac9296f46c72",
  "returnObj": {
    "RecordTemplateId": "717074786139029504",
    "CreatedTime": "2023-04-25 15:15:07",
    "UpdatedTime": "2023-04-25 15:15:07",
    "RequestId": "a194d4c32d4d4e489f70ac9296f46c72"
  }
}

状态码

请参考状态码说明。

错误码

请参考错误码说明。

创建存储模板

最近更新时间：2026-03-19 18:16:28