云数据库 MySQL 查询实例发生的事件信息-实例相关接口-API 中心-腾讯云

1. 接口描述

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

本接口（DescribeInstanceAlarmEvents）用于查询实例发生的事件信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInstanceAlarmEvents。
Version	是	String	公共参数，本接口取值：2017-03-20。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例 ID。示例值：cdb-0mu6taqx
StartTime	是	String	事件查询范围开始时间，闭区间。示例值：2024-01-15 00:00:00
EndTime	是	String	事件查询范围截止时间，闭区间。示例值：2024-01-30 00:00:00
EventName.N	否	Array of String	事件名称。 Outofmemory - 内存OOM（有状态事件）; Switch - 主从切换（有状态事件）; Roremove - 只读实例剔除（有状态事件）; MemoryUsedHigh - 内存使用率过高（有状态事件）; CPUExpansion - CPU性能扩容（无状态事件）; CPUExpansionFailed - CPU性能扩容失败（无状态事件）; CPUContraction - CPU性能回缩（无状态事件）; Restart - 实例重启（有状态事件）; ServerFailureNodeMigration - ServerFailureNodeMigration（有状态事件）; PlannedSwitch - 计划内主备切换（无状态事件）; OverusedReadonlySet - 实例将被锁定（无状态事件）; OverusedReadWriteSet - 实例解除锁定（无状态事件）。示例值：["Switch"]
EventStatus	否	String	事件状态。"1" - 发生事件；"0" - 恢复事件；"-" - 无状态事件。示例值：1
Order	否	String	排序方式。按事件发生事件进行排序，"DESC"-倒排；”ASC“-正序，默认倒排。示例值：DESC
Limit	否	String	事件展示数量。示例值：10
Offset	否	String	偏移量。示例值：0
NodeId	否	String	节点 ID。示例值：dbn-it3iv15s

3. 输出参数

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

4. 示例

示例1 查询实例事件信息

输入示例

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

{
    "InstanceId": "cdb-fbd5agyt",
    "StartTime": "2024-11-15 00:00:00",
    "EndTime": "2024-12-15 00:00:00",
    "EventName": [
        "PlannedSwitch"
    ],
    "EventStatus": "1",
    "Limit": "100"
}

输出示例

{
    "Response": {
        "Items": [
            {
                "EventName": "PlannedSwitch",
                "EventStatus": "1",
                "InstanceId": "cdb-fbd5agyt",
                "NodeId": "",
                "OccurTime": "2024-11-25 14:46:42"
            }
        ],
        "RequestId": "971e2860-c55b-4323-a831-0001",
        "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. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

查询实例发生的事件信息

本页目录：