文档

RestartDedicatedHost - 重启专属集群的主机

更新时间:

调用RestartDedicatedHost接口重启专属集群的主机。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

主机所在的地域 ID

cn-hangzhou
DedicatedHostIdstring

主机 ID。您可以登录云数据库专属集群控制台,在主机列表查看并获取主机 ID。

ch-bp10a5id3boqi****
FailoverModestring

主实例的切换方案,取值:

  • MaintainTime(默认):在实例维护时间段切换,等待当前主机上的主实例切换到其他主机的备实例后再重启主机,避免影响业务。
  • Immediate:立即切换,即立即强制重启主机。
MaintainTime
ForceStopboolean

是否强制关机重启,取值:

  • true:强制重启。执行断电操作,所有未写入存储设备的缓存数据会丢失,请谨慎选择。

  • false(默认值):正常重启。

说明 该参数仅对 Tair 主机生效,其余引擎主机重启均为正常重启。
false

返回参数

名称类型描述示例值
object
DedicatedHostIdstring

主机 ID。

ch-bp10a5id3boqi****
RequestIdstring

请求 ID。

D6E068C3-25BC-455A-85FE-45F0B22EDSH
TaskIdinteger

任务 ID。

10254125

示例

正常返回示例

JSON格式

{
  "DedicatedHostId": "ch-bp10a5id3boqi****",
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22EDSH",
  "TaskId": 10254125
}

错误码

HTTP status code错误码错误信息描述
400InvalidUserId.NotSupportThe userid have no permission.-
403InvalidAction.NotSupportThe host status does not support the operation.当前主机状态不支持此操作
404HostInfo.NotFoundSpecified hostinfo is not found.-

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈