修改实例事件

最近更新时间:2024-04-02 01:21:01

我的收藏

1. 接口描述

接口请求域名: redis.tencentcloudapi.com 。

本接口(ModifyInstanceEvent)用于修改实例的运维事件的执行计划。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyInstanceEvent。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 指定实例 ID。例如:crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。
示例值:crs-deindi7de
EventId Integer 事件 ID。请通过 DescribeInstanceEvents 获取需修改的事件 ID。
示例值:89
StartTime String 修改事件执行的计划开始时间。
示例值:03:10
EndTime String 修改事件计划执行的结束时间。开始时间配置之后,结束时间只能选择在开始时间之后的 30 分钟、1 小时、1.5 小时、2 小时和 3 小时之内。
示例值:04:10
ExecutionDate String 修改事件执行计划的开始日期。
示例值:2018-09-10
Status String 修改事件的运行状态。该参数当前仅支持设置为 Canceled, 即取消执行当前事件。可通过 DescribeInstanceEvents 接口查询当前事件的运行状态与事件级别。
- 事件级别为Critical(关键)或 High(重要)类事件不支持取消。即严重的事件必须执行,不可取消。
- 仅运行状态为 Waiting (待执行的事件)的事件,才能执行取消操作。
示例值:Canceled

3. 输出参数

参数名称 类型 描述
EventId Integer 事件 ID。
示例值:89
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改实例事件信息

修改实例事件信息

输入示例

POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceEvent
<公共请求参数>

{
    "InstanceId": "crs-b6wst31p",
    "EventId": 10,
    "StartTime": "22:00",
    "EndTime": "23:01",
    "ExecutionDate": "2023-09-18"
}

输出示例

{
    "Response": {
        "EventId": 10,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.SystemError 内部系统错误,和业务无关。
InternalError.DbOperationFailed 统一的 DB 操作错误,可以是 update insert select..。
InvalidParameter.InvalidParameter 业务参数错误。
UnauthorizedOperation.NoCAMAuthed 无cam 权限。
UnsupportedOperation.InstanceNotOperation 不支持当前操作。