云数据库 Redis 查询实例事件信息-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口（DescribeInstanceEvents）用于查询 Redis 实例事件信息。

默认接口请求频率限制：50次/秒。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInstanceEvents。
Version	是	String	公共参数，本接口取值：2018-04-12。
Region	是	String	公共参数，详见产品支持的地域列表。
ExecutionStartDate	是	String	配置查询事件执行计划的起始日期。示例值：2018-09-10
ExecutionEndDate	是	String	配置查询事件执行计划的结束日期。示例值：2018-09-10
InstanceId	否	String	指定实例 ID。例如：crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。示例值：crs-asdasdas
PageSize	否	Integer	输出每页显示事件的数量，默认：10。示例值：10
PageNo	否	Integer	配置查询事件的输出页码，即支持根据PageNo（页码）与 PageSize （每页输出数量）查询某一页的事件。默认：1。示例值：1
Status.N	否	Array of String	事件当前状态。 - Waiting：未到达执行日期或不在维护时间窗内的事件。 - Running：在维护时间窗内，正在执行维护的事件。 - Finished：已全部完成维护的事件。 - Canceled：已取消执行的事件。示例值：Running
EventTypes.N	否	Array of String	事件类型，当前仅支持配置实例迁移、资源腾挪、机房裁撤相关的运维操作。该参数仅支持配置为 InstanceMigration。示例值：InstanceMigration
Grades.N	否	Array of String	配置查询事件等级。事件等级根据其影响严重程度和紧急程度进行分级，由重至轻依次为关键、重要、中等、一般。 - Critical：关键 - High：重要 - Middle：中等 - Low：一般示例值：Low

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	总条数示例值：100
RedisInstanceEvents	Array of RedisInstanceEvent	实例事件信息示例值：RedisInstanceEvent
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例事件

查询实例事件

输入示例

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

{
    "InstanceId": "crs-b6wst31p",
    "PageSize": 20,
    "PageNo": 1,
    "ExecutionStartDate": "2023-10-04",
    "ExecutionEndDate": "2023-10-04",
    "Grades": [
        "Low"
    ],
    "Status": [
        "Waiting"
    ],
    "EventTypes": [
        "InstanceMigration"
    ]
}

输出示例

{
    "Response": {
        "RedisInstanceEvents": [
            {
                "EffectInfo": "迁移完成时会有一次秒级别的闪断",
                "EndTime": "22:00",
                "ExecutionDate": "2023-09-18",
                "Grade": "Low",
                "ID": 10,
                "InitialExecutionDate": "2023-08-19",
                "InstanceId": "crs-b6wst31p",
                "InstanceName": "benyqhuang8",
                "LatestExecutionDate": "2023-09-18",
                "StartTime": "21:00",
                "Status": "Waiting",
                "TaskEndTime": "0000-00-00 00:00:00",
                "Type": "InstanceMigration"
            }
        ],
        "RequestId": "36a33a3d-f9ce-47c1-87d0-84869a37466d",
        "TotalCount": 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: 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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.SystemError	内部系统错误，和业务无关。
InternalError.DbOperationFailed	统一的 DB 操作错误，可以是 update insert select..。
InvalidParameter.ActionNotFound	没有找到对应接口。
InvalidParameter.InvalidParameter	业务参数错误。
InvalidParameter.PermissionDenied	接口没有cam权限。
UnauthorizedOperation.NoCAMAuthed	无cam 权限。
UnsupportedOperation.InstanceNotOperation	不支持当前操作。