1. 接口描述
接口请求域名: iotvideoindustry.tencentcloudapi.com 。
本接口(GetTimeTemplates)用于获取时间模板列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetTimeTemplates。 |
Version | 是 | String | 公共参数,本接口取值:2020-12-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Templates | Array of TimeTemplateItem | 时间模板列表 注意:此字段可能返回 null,表示取不到有效值。 |
TotalCount | Integer | 时间模板总数 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取时间模板列表
输入示例
POST / HTTP/1.1
Host: iotvideoindustry.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetTimeTemplates
<公共请求参数>
{}
输出示例
{
"Response": {
"RequestId": "f8375a13-7189-42f2-93f7-1aaca6eaf25d",
"Templates": [
{
"TemplateId": "tgrp-jfs89ahg",
"Name": "全天候模板",
"IsAllWeek": 1,
"Type": 0,
"TimeTemplateSpecs": []
},
{
"TemplateId": "tgrp-fmwq1f1a",
"Name": "工作日模板",
"IsAllWeek": 0,
"Type": 0,
"TimeTemplateSpecs": [
{
"DayofWeek": 1,
"BeginTime": "00:00",
"EndTime": "23:59"
},
{
"DayofWeek": 2,
"BeginTime": "00:00",
"EndTime": "23:59"
},
{
"DayofWeek": 3,
"BeginTime": "00:00",
"EndTime": "23:59"
},
{
"DayofWeek": 4,
"BeginTime": "00:00",
"EndTime": "23:59"
},
{
"DayofWeek": 5,
"BeginTime": "00:00",
"EndTime": "23:59"
}
]
},
{
"TemplateId": "tgrp-ttcqknio",
"Name": "周末模板",
"IsAllWeek": 0,
"Type": 0,
"TimeTemplateSpecs": [
{
"DayofWeek": 6,
"BeginTime": "00:00",
"EndTime": "23:59"
},
{
"DayofWeek": 7,
"BeginTime": "00:00",
"EndTime": "23:59"
}
]
},
{
"TemplateId": "tgrp-qfr07ro5",
"Name": "xx",
"IsAllWeek": 1,
"Type": 1,
"TimeTemplateSpecs": []
},
{
"TemplateId": "tgrp-712kfd0s",
"Name": "xx",
"IsAllWeek": 1,
"Type": 1,
"TimeTemplateSpecs": []
},
{
"TemplateId": "tgrp-a6gvpkzu",
"Name": "xx",
"IsAllWeek": 1,
"Type": 1,
"TimeTemplateSpecs": []
}
],
"TotalCount": 6
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。