ModifyPlannedEventExecuteTime--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

ModifyPlannedEventExecuteTime

最近更新时间：2025.05.28 10:32:25首次发布时间：2025.05.28 10:32:25

调用 ModifyPlannedEventExecuteTime 接口修改计划内系统运维事件的执行时间。

请求类型

同步请求。

注意事项

计划内运维事件开始执行后会进入执行中状态。运维事件执行过程中可能会出现实例节点切换的情况，节点切换过程中可能会出现秒级的不可写或连接闪断情况，请确保您的业务具备自动重连机制。更多关于支持的事件操作及对业务的影响详情，请参见事件类型与操作影响。
计划内运维事件执行前会处于等待执行状态。此时，数据库本身正常的数据访问不会受到任何影响。
计划内运维事件结束后，实例的连接地址和访问方式跟原实例保持一致，实例的网络配置不会改变，迁移任务也不会受运维事件的影响。
Redis 未限制推迟执行时间的操作次数，但每次设置的推迟执行时间都需晚于上一次计划执行时间的结束时间，同时早于最晚可推迟时间。更多详情，请参见更改事件执行时间。

请求参数

参数	类型	是否必选	示例值	描述
EventIds	String[]	是	["event-cn0212gzmh2xs****"]	需要修改执行时间的计划内事件 ID。仅 `CanModifyTime` 值为 `true` 的计划内事件允许修改执行时间。说明您可以调用 DescribePlannedEvents 接口查询目标 Redis 实例在指定时间段的计划内事件信息，包括是否允许修改执行时间以及事件 ID。支持一次传入多个事件 ID，多个 ID 间用英文逗号（,）分隔。
TargetStartTime	String	是	2025-05-13T19:00:00Z	修改后的计划开始时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`（UTC）。
TargetEndTime	String	是	2025-05-23T19:59:59Z	修改后的计划结束时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`（UTC）。说明计划结束时间需晚于计划开始时间，但需早于当前事件所允许的最晚可推迟时间。您可以调用 DescribePlannedEvents 接口查询目标 Redis 实例在指定时间段的计划内事件信息，包括最晚可推迟时间（即返回结果中 `MaxEndTime`的值）。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

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

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=ModifyPlannedEventExecuteTime&Version=2020-12-07 HTTP/1.1
Host: redis.cn-beijing.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=****
{
    "EventIds": [
        "event-cn0212gzmh2xs****"
    ],
    "TargetStartTime": "2025-05-13T19:00:00Z",
    "TargetEndTime": "2025-05-23T19:59:59Z"
}

返回示例

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

错误码

更多详情，请参见错误码。