You need to enable JavaScript to run this app.
导航
ModifyMaintenanceTime
最近更新时间:2025.03.20 10:27:02首次发布时间:2025.03.20 10:27:02
我的收藏
有用
有用
无用
无用

调用 ModifyMaintenanceTime 接口修改目标 Redis 企业版实例的可维护时间段。

请求类型

同步请求。

注意事项

  • 若在可维护时间段内执行了变更实例配置操作,实例可能出现连接闪断,建议将可维护时间设置在业务低峰期,并确保应用具备自动重连机制。更多详情,请参见设置可维护时间段
  • 若在执行一些数据库运维操作(如变更配置)时,选择了在可维护时间段执行,此时实例状态会立即改变(如变为变更配置中)且该状态会一直持续到任务完成,但操作任务的真正执行时间仍然是可维护时间段内

请求参数

参数
类型
是否必选
示例值
描述
InstanceId
String
redis-cn0212gzmh2xs****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息,包括实例 ID。

TimeScope
String
00:00-01:59

设置实例的可维护时间段范围,格式为HH:mm-HH:mm(UTC+8),

说明

  • 传入的可维护时间段范围中,起始时间的 mm 必须为 00,结束时间的 mm 必须为 59。例如,您可以设置可维护时间段为 00:00-01:59
  • 为保证任务能够在可维护时间段内正常进行,可维护时间段的开始和结束时间间隔需大于等于 2 小时且小于等于 24 小时。
ClientToken
String
WbiAlPqJM6tMoSOYhT****
用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感且不超过 127 个 ASCII 字符。

返回参数

本接口无特有的返回参数。更多信息请见返回结构

示例

请求示例

POST https://redis.volcengineapi.com/?Action=ModifyMaintenanceTime&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "redis-cn0212gzmh2xs****",
    "TimeScope": "00:00-01:59"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****10023228002****",
        "Action": "ModifyMaintenanceTime",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

更多详情,请参见错误码