云数据库 MySQL 版
云数据库 MySQL 版
云数据库 MySQL 版
文档指南
请输入
产品动态
内核功能
功能
用户指南
实例管理
连接管理
管理连接终端
备份恢复
服务可用性
日志管理
数据安全管理
参数管理
跨地域备份管理
API 参考
V2（2022-01-01）
实例管理
连接管理
账号管理
数据库管理
安全加密
备份与恢复
参数管理
资源包管理
附录
开发者工具
最佳实践
相关协议
- 文档首页
云数据库 MySQL 版API 参考V2（2022-01-01）事件管理DescribePlannedEvents - 查询运维事件
复制全文
下载 pdfDescribePlannedEvents - 查询运维事件
文档反馈
问问助手调用 DescribePlannedEvents 接口查询运维事件。
请求类型
同步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
InstanceId | String | 否 | mysql-d4942fd7**** | 实例 ID。 |
BeginTime | String | 否 | 2023-08-03T06:25:22Z | 事件发生的开始时间。格式为 yyyy-MM-dd HH:mm:ss（UTC 时间）。 |
EndTime | String | 否 | 2023-08-12T06:25:34Z | 事件发生的结束时间。格式为 yyyy-MM-dd HH:mm:ss（UTC 时间）。 |
EventId | String | 否 | df078de739d3412aa430905bcd13**** | 事件 ID。 |
EventType | Array of String | 否 | ["VersionUpgrade"] | 事件种类。取值：
|
Status | Array of String | 否 | ["Waiting"] | 事件状态。取值范围如下（可取多个值）：
|
返回参数
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Total | Integer | 3 | 计划内事件总数。 |
PlannedEvents | 请参见返回示例。 | 计划内事件的信息。 |
PlannedEvent
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
BusinessImpact | String | 切换过程中可能会出现秒级连接闪断，建议为程序设置自动重试和重连机制以避免对业务产生影响 | 事件造成的影响。 |
DBEngine | String | MySQL | 数据库引擎，取固定值 MySQL。 |
EventAction | String | RestartDBInstance | 相应事件类型内的具体操作接口名称。例如实例管理内有创建、删除、变配、重启等等。 |
EventID | String | d64eda8b7f47414e95a4e4654032**** | 事件 ID。 |
EventName | String | 这是一个事件名称 | 事件名称。 |
EventType | String | VersionUpgrade | 事件类型。 |
InstanceId | String | mysql-5564bc65**** | 实例 ID。 |
InstanceName | String | 测试实例 | 实例名称。 |
MaxDelayTime | String | 2024-12-18T15:03:05Z | 最晚可推迟时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
OriginBeginTime | String | 2024-12-17T15:03:05Z | 最初设定的开始时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
PlannedBeginTime | String | 2024-12-18T14:48:00Z | 计划执行的开始时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
PlannedEndTime | String | 2024-12-19T14:48:00Z | 计划执行的结束时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
PlannedEventDescription | String | upgrade instance to 2.10.2.28 | 运维事件的描述信息。 |
PlannedEventReason | String | 实例宿主机硬件老化异常需要维护, 或者主机模块需要升级 | 事件产生的原因，便于您了解非预期事件产生的原因。 |
PlannedSwitchBeginTime | String | 2024-12-18T15:03:00Z | 计划切换的开始时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
PlannedSwitchEndTime | String | 2024-12-19T15:03:00Z | 计划切换的结束时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
Region | String | cn-beijing | 地域。 |
Status | String | Waiting | 事件状态。
|
示例
请求示例
POST /?Action=DescribePlannedEvents&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mysql.cn-beijing.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
"StartTime": "2024-01-08T06:00:00Z",
"EndTime": "2024-01-15T06:00:00Z"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230810145403789088F993D213731417",
"Action": "DescribePlannedEvents",
"Version": "2022-01-01",
"Service": "rds_mysql",
"Region": "cn-beijing"
},
"Result": {
"PlannedEvents": [
{
"BusinessImpact": "火山引擎数据库控制台实例列表页面会有短暂的状态展示延迟，不影响数据库使用",
"DBEngine": "MySQL",
"EventAction": "UpgradeResource",
"EventID": "d64eda8b7f47414e95a4e46540320b70",
"InstanceId": "mysql-5564bc65****",
"InstanceName": "测试实例",
"IsUrgent": true,
"MaxDelayTime": "2024-02-02T15:10:00Z",
"OriginBeginTime": "2024-01-02T15:10:00Z",
"PlannedBeginTime": "2024-01-02T15:10:00Z",
"PlannedEndTime": "2024-01-02T15:59:00Z",
"PlannedEventDescription": "upgrade instance to 2.10.2.28",
"PlannedEventReason": "instance version upgrade",
"Region": "cn-beijing",
"Status": "Initiated"
}
],
"Total": 1
}
}
错误码
最近更新时间：2026.04.09 11:58:30
这个页面对您有帮助吗？
有用
有用
无用
无用