文档中心

云数据库 MySQL 版

实例管理

RestartDBInstance - 重启实例

RestartDBInstance - 重启实例

调用 RestartDBInstance 接口重启实例。

请求类型

异步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-e26822cf****	实例 ID。
ApplyScope	String	否	AllNode	重启场景，取值： AllNode：所有节点。 CustomNode：自定义只读节点。
CustomNodeIds	Array of String	否	["mysql-e26822cf**-r90ab","mysql-e26822cf**-r84eb"]	需要重启的节点 ID。节点 ID 需以数组的形式传入。说明当 ApplyScope 取值为 AllNode 时，不需要传入该参数，表示重启整个实例。当 ApplyScope 取值为 CustomNode时，该参数传入需要重启的只读节点 ID。
SwitchType	String	否	MaintainTime	执行时间，取值： Immediate：立即切换（默认）。 MaintainTime：可维护时间段内进行切换。 SpecifiedTime：指定时间段内进行切换。说明可调用 DescribeDBInstanceDetail 接口查询实例的可维护时间段。取值为 SpecifiedTime 时，需要在参数 SpecifiedSwitchStartTime 和 SpecifiedSwitchEndTime中设定时间段的起止时间。
SpecifiedSwitchStartTime	String	否	2024-12-25T14:00:00Z	指定时间段执行时，时间段的起始时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ssZ。说明 SwitchType 取值为 SpecifiedTime 时，该参数为必填参数。任务执行的起始时间不得晚于当前日期后的第 7 日。需为整点时间。
SpecifiedSwitchEndTime	String	否	2024-12-25T15:59:00Z	指定时间段执行时，时间段的结束时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ssZ。说明 SwitchType 取值为 SpecifiedTime 时，该参数为必填参数。指定时间段的最短时长为一小时五十九分钟。不支持跨天设置时间段，即任务执行的起始时间和结束时间不超过 24 小时。
ForceRestartMaster	Boolean	否	false	是否进行强制重启。取值： true：是。 false：否。默认值。说明如实例为单节点实例，ForceRestartMaster 只能取值为 true。
RestartWithProxy	Boolean	否	false	是否在重启实例时重启实例的数据库代理。取值： true：是。默认值。 false：否。说明仅在实例的数据库代理功能开启时支持配置。单节点实例不支持该功能。

返回参数

null

示例

请求示例 1

重启整个实例

返回示例 1

请求示例 2

重启指定只读节点

返回示例 2

请求示例 3

在可维护时间段内重启整个实例

返回示例 3

错误码

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

最近更新时间：2026.10.23 17:52:42

这个页面对您有帮助吗？

有用

有用

无用

无用