文档首页/ 云堡垒机 CBH/ API参考/ API说明/ 操作管理/ 重启堡垒机实例
更新时间：2024-06-13 GMT+08:00
在线调试
CLI示例
查看PDF
分享

重启堡垒机实例

功能介绍

重启云堡垒机实例。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/cbs/instance/reboot

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

获取方法详见API参考，附录"获取项目ID"

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

可参考"IAM获取IAM用户Token"获取
表3 请求Body参数

参数

是否必选

参数类型

描述

server_id

是

String

云堡垒机实例ID，使用UUID格式表示。

获取方法详见用户指南里面的实例"查看实例详情"

reboot_type

是

String

重启方式，不区分大小写。

  • SOFT：普通重启，关闭虚拟机服务

  • HARD：强制重启，重启虚拟机

响应参数

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

请求参数错误。

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

校验TOKEN失败。

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

租户无权限操作。

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

没有找到CBH资源。

请求示例

{
  "server_id" : "c7277d87-5a0d-4cfc-a418-97acb567cf29",
  "reboot_type" : "SOFT"
}

响应示例

无

状态码

状态码

描述

200

Restart Cbh Instance Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 操作管理

相关文档