1. 接口描述
接口请求域名: mongodb.tencentcloudapi.com 。
本接口(SetInstanceMaintenance ) 用于设置实例维护时间窗。
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:SetInstanceMaintenance。 | 
| Version | 是 | String | 公共参数,本接口取值:2019-07-25。 | 
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 | 
| InstanceId | 是 | String | 指定实例ID。例如:cmgo-p8vn****。请登录 MongoDB 控制台在实例列表复制实例 ID。 示例值:cmgo-7pjedvz7  | 
| MaintenanceStart | 是 | String | 维护时间窗开始时间。取值范围为"00:00-23:00"的任意整点或半点,如00:00或00:30。 示例值:"04:00"  | 
| MaintenanceEnd | 是 | String | 维护时间窗结束时间。 - 取值范围为"00:00-23:00"的任意整点或半点,维护时间持续时长最小为30分钟,最大为3小时。 - 结束时间务必是基于开始时间向后的时间。 示例值:"05:00"  | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 修改实例维护时间窗口
修改实例维护时间窗口
输入示例
输出示例
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: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
 
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| InternalError | 内部错误。 | 
| InternalError.CheckAppIdFailed | appId校验失败。 | 
| InvalidParameter | 参数错误。 |