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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String RestartDedicatedHost

系统规定参数。取值:RestartDedicatedHost

RegionId String cn-hangzhou

主机所在的地域ID

DedicatedHostId String ch-bp10a5id3boqi****

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

FailoverMode String MaintainTime

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

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

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

  • true:强制重启。执行断电操作,所有未写入存储设备的缓存数据会丢失,请谨慎选择。
  • false(默认值):正常重启。
说明 该参数仅对Tair主机生效,其余引擎主机重启均为正常重启。

返回数据

名称 类型 示例值 描述
DedicatedHostId String ch-bp10a5id3boqi****

主机ID。

RequestId String D6E068C3-25BC-455A-85FE-45F0B22EDSH

请求ID。

TaskId Integer 10254125

任务ID。

示例

请求示例

http(s)://cddc.aliyuncs.com/?Action=RestartDedicatedHost
&DedicatedHostId=dhg-h5i4p331f509****
&FailoverMode=MaintainTime
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RestartDedicatedHostReponse>
<DedicatedHostId>ch-bp10a5id3boqi****</DedicatedHostId>
<TaskId>10254125</TaskId>
<RequestId>D6E068C3-25BC-455A-85FE-45F0B22EDSH</RequestId>
</RestartDedicatedHostReponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
403 InvalidAction.NotSupport The host status does not support the operation. 当前主机状态不支持此操作

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