1. 接口描述
接口请求域名: cdb.tencentcloudapi.com 。
本接口(AddTimeWindow)用于添加云数据库实例的维护时间窗口,以指定实例在哪些时间段可以自动执行切换访问操作。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AddTimeWindow。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例ID,格式如:cdb-c1nl9rpv 或者 cdbro-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。 示例值:cdb-eb2w7dto |
Monday.N | 否 | Array of String | 星期一的可维护时间段,其中每一个时间段的格式形如:10:00-12:00;起始时间按半个小时对齐;最短半个小时,最长三个小时;可设置多个时间段。 一周中应至少设置一天的时间窗。下同。 示例值:["02:00-03:00\n"] |
Tuesday.N | 否 | Array of String | 星期二的可维护时间窗口。 一周中应至少设置一天的时间窗。 |
Wednesday.N | 否 | Array of String | 星期三的可维护时间窗口。 一周中应至少设置一天的时间窗。 |
Thursday.N | 否 | Array of String | 星期四的可维护时间窗口。 一周中应至少设置一天的时间窗。 |
Friday.N | 否 | Array of String | 星期五的可维护时间窗口。 一周中应至少设置一天的时间窗。 |
Saturday.N | 否 | Array of String | 星期六的可维护时间窗口。 一周中应至少设置一天的时间窗。 |
Sunday.N | 否 | Array of String | 星期日的可维护时间窗口。 一周中应至少设置一天的时间窗。 |
MaxDelayTime | 否 | Integer | 最大延迟阈值,仅对主实例和灾备实例有效 示例值:10 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 添加维护时间窗口
输入示例
https://cdb.tencentcloudapi.com/?Action=AddTimeWindow
&InstanceId=cdb-eb2w7dto
&Monday.0=02:00-03:00
&MaxDelayTime=10
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InstanceNotFound | 实例不存在。 |
InvalidParameter.ResourceExists | 资源已存在。 |