1. 接口描述
接口请求域名： iss.tencentcloudapi.com 。
用于新增实时上云模板
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：AddRecordTemplate。 |
| Version | 是 | String | 公共参数，本接口取值：2023-05-17。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| TemplateName | 是 | String | 模板名称， 仅支持中文、英文、数字、_、-，长度不超过32个字符，模板名称全局唯一，不能为空，不能重复 示例值：全天模板 |
| TimeSections.N | 是 | Array of RecordTemplateTimeSections | 上云时间段，按周进行设置，支持一天设置多个时间段，每个时间段不小于10分钟 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | RecordTemplateInfo | 返回结果 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddRecordTemplate
<公共请求参数>
{
"TemplateName": "name",
"TimeSections": [
{
"DayOfWeek": 1,
"StartTime": "08:00:00",
"EndTime": "12:00:00"
},
{
"DayOfWeek": 1,
"StartTime": "20:30:00",
"EndTime": "23:400:00"
},
{
"DayOfWeek": 2,
"StartTime": "12:10:00",
"EndTime": "16:10:00"
},
{
"DayOfWeek": 7,
"StartTime": "00:00:00",
"EndTime": "23:59:59"
}
]
}输出示例
{
"Response": {
"Data": {
"TemplateId": "48676e89a8c**********baa36220fa4",
"TemplateName": "name",
"TimeSections": [
{
"DayOfWeek": 1,
"StartTime": "08:00:00",
"EndTime": "12:00:00"
},
{
"DayOfWeek": 1,
"StartTime": "20:30:00",
"EndTime": "23:400:00"
},
{
"DayOfWeek": 2,
"StartTime": "12:10:00",
"EndTime": "16:10:00"
},
{
"DayOfWeek": 7,
"StartTime": "00:00:00",
"EndTime": "23:59:59"
}
]
},
"RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败 |
| InvalidParameter.InvalidBodyFormat | 无效的消息体格式 |
| InvalidParameter.InvalidTimeSection | 无效的时间片段 |
| InvalidParameterValue.EmptyName | 名称不能为空 |
| InvalidParameterValue.IllegalName | 名称中包含不符合要求的字符(仅支持中文、英文、数字、_、-) |
| InvalidParameterValue.InvalidTimeSectionValue | 无效时间片段取值 |
| InvalidParameterValue.StartTimeGreaterThanOrEqualEndTime | 开始时间不能大于等于结束时间 |
| InvalidParameterValue.TimeLessThanTenMinutes | 时间间隔不能小于10分钟 |
| InvalidParameterValue.TooLongName | 名称过长 |
| MissingParameter.EmptyTimeSection | 时间片段不存在 |
| ResourceInUse.TemplateNameRepeat | 模板名称不能重复 |