创建时间模板

最近更新时间:2024-03-12 01:35:41

我的收藏

1. 接口描述

接口请求域名: iotvideoindustry.tencentcloudapi.com 。

本接口(CreateTimeTemplate) 用于根据模板描述的具体录制时间片段,创建定制化的时间模板。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateTimeTemplate。
Version String 公共参数,本接口取值:2020-12-01。
Region String 公共参数,详见产品支持的 地域列表
Name String 时间模板名称
示例值:myTemplate
IsAllWeek Integer 是否为每周全时录制(即7*24h录制),0:非全时录制,1;全时录制,默认0
示例值:0
TimeTemplateSpecs.N Array of TimeTemplateSpec 当IsAllWeek为0时必选,用于描述模板的各个时间片段

3. 输出参数

参数名称 类型 描述
TemplateId String 时间模板ID
示例值:template-xxx
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 CreateTimeTemplate

输入示例

POST / HTTP/1.1
Host: iotvideoindustry.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTimeTemplate
<公共请求参数>

{
    "IsAllWeek": 0,
    "TimeTemplateSpecs": [
        {
            "DayofWeek": 1,
            "EndTime": "12:30",
            "BeginTime": "14:30"
        }
    ],
    "Name": "myTemplate"
}

输出示例

{
    "Response": {
        "RequestId": "e1b9e7ac-0989-4af9-a454-26f69d6997d9",
        "TemplateId": "template-xxx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameterValue.TemplateSpecEmpty 模板时间片段为空。
UnsupportedOperation.TemplateExist 该名字时间模板已创建,请修改其他模板名字。