调用RestartDedicatedHost接口重启专属集群的主机。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cddc:RestartDedicatedHost | update | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 主机所在的地域 ID。 | cn-hangzhou |
| DedicatedHostId | string | 是 | 主机 ID。您可以登录云数据库专属集群控制台，在主机列表查看并获取主机 ID。 | ch-bp10a5id3boqi**** |
| FailoverMode | string | 是 | 主实例的切换方案，取值：
| MaintainTime |
| ForceStop | boolean | 否 | 是否强制关机重启，取值：
说明
该参数仅对 Tair 主机生效，其余引擎主机重启均为正常重启。
| false |
返回参数
示例
正常返回示例
JSON格式
{
"DedicatedHostId": "ch-bp10a5id3boqi****",
"RequestId": "D6E068C3-25BC-455A-85FE-45F0B22EDSH",
"TaskId": 10254125
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidUserId.NotSupport | The userid have no permission. | - |
| 403 | InvalidAction.NotSupport | The host status does not support the operation. | 当前主机状态不支持此操作 |
| 404 | HostInfo.NotFound | Specified hostinfo is not found. | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史