创建录制模板--慢直播-火山引擎

文档中心

立即注册

导航

创建录制模板

最近更新时间：2023.07.12 14:14:43首次发布时间：2021.11.25 17:22:10

创建录制模板。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	CreateRecordTemplate
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01

Body 参数

字段	类型	必填	说明
TemplateName	String	是	模板名称，支持汉字、大小写字母、数字、中划线
Record	Array of Objects	是	录制配置，参考以下录制配置结构说明

录制配置结构说明

字段	类型	必填	说明
RecordDuration	Integer	是	单个视频文件录制时长（切片周期），单位：毫秒
Type	String	是	录制方式： realtime（实时录制）
Format	String	是	视频存储格式： mp4 hls
EnableTimes	Array of Objects	是	录制生效时间配置，参考以下生效时间结构说明
Bucket	Object	是	录制文件存储配置，参考以下对象存储结构说明
TTL	Object	是	录像过期时间配置，参考以下录像过期时间结构说明

生效时间结构说明

字段	类型	必填	说明
Weekdays	Integer	是	录制模板在一周内的使能日期（可选值：1-7，1代表星期一，7代表星期日）
EnableFrom	String	是	录制模板使能开始时间，例如：09:09:09
EnableTo	String	是	录制模板使能结束时间，例如：10:10:10
Enable	Boolean	是	是否启用

对象存储结构说明

字段	类型	必填	说明
UploadType	String	是	存储录制文件的类型：空值（默认存储在慢直播服务账号的对象存储中） aiot（存储在慢直播服务账号的对象存储中） tos（存储在用户火山引擎账号的对象存储中）
Endpoint	String	否	（当 UploadType 为 tos 时，必填）对象存储服务地址，可通过火山引擎控制台获取；例如：`tos-cn-beijing.volces.com`
Region	String	否	（当 UploadType 为 tos 时，必填）存储对象服务区域，可通过火山引擎控制台获取；例如：`cn-beijing`
Name	String	否	（当 UploadType 为 tos 时，必填）对象存储中的存储桶名称，可通过火山引擎控制台获取；例如：`test-bucket`

录像过期时间结构说明

字段	类型	必填	说明
Days	Integer	否	录像文件标准存储时长（天，默认7天）
TransConfigs	Array of Objects	否	（当 UploadType 为 tos 时，可配置）录像文件在对象存储中的生命周期配置，参考以下 TransConfigs 结构说明

TransConfigs 结构说明

字段	类型	必填	说明
StorageClass	String	是	在对象存储中保存录像文件的类型，可选项： STANDARD（标准存储） IA（低频存储） ARCHIVE_FR（归档闪回存储） COLD_ARCHIVE（冷归档存储）详细说明，参考生命周期规则
Days	Integer	是	与指定的存储类型对应的存储时长（天）

字段

类型

必填

说明

StorageClass

String

是

在对象存储中保存录像文件的类型，可选项：

STANDARD（标准存储）
IA（低频存储）
ARCHIVE_FR（归档闪回存储）
COLD_ARCHIVE（冷归档存储）

详细说明，参考生命周期规则

Days

Integer

是

与指定的存储类型对应的存储时长（天）

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。

Result 字段包含以下参数：

字段	类型	说明
ID	String	创建成功的录制模板 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=CreateRecordTemplate
&Version=2021-01-01
&<公共请求参数>
{
    "TemplateName": "record-template-01",
    "Record": {
        "RecordDuration": 600000,
        "Type": "realtime",
        "Format": "hls",
        "EnableTimes": [
            {
                "Weekdays": 1
                "EnableFrom":"09:00:00",
                "EnableTo":"10:00:00",
                "Enable": true
            },
            {
                "Weekdays": 1
                "EnableFrom":"11:00:00",
                "EnableTo":"14:00:00",
                "Enable": true
            },
            {
                "Weekdays": 3
                "EnableFrom":"09:00:00",
                "EnableTo":"10:00:00",
                "Enable": true
            }
        ],
        "Bucket": {
            "UploadType": "tos"
            "Endpoint": "tos-cn-beijing.volces.com",
            "Region": "cn-beijing",
            "Name": "test-bucket"
        },    
        "TTL": {
           "Days": 7,
           "TransConfigs": [
               {
                   "Days": 10,
                   "StorageClass": "COLD_ARCHIVE"
               }
           ]
       }
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202112081959560102120440190A0025C8",
        "Action": "CreateRecordTemplate",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "3694598f-6b59-4c3d-9ea4-13dd8exxxxxx"
    }
}