文档首页/ 智能边缘云 IEC/ API参考/ API/ 边缘实例/ 切换操作系统
更新时间：2024-01-02 GMT+08:00
查看PDF
分享

切换操作系统

功能介绍

切换边缘实例操作系统，支持边缘实例创建成功后，保持ip、数据盘不变的情况下重装操作系统。

调用该接口后，系统将卸载系统盘，然后使用新镜像重新创建系统盘，并挂载至实例，实现切换操作系统功能。

接口约束

  • 关机状态或者重装/切换操作系统失败的边缘实例才能执行切换操作。

  • 不包含系统盘的边缘实例不能切换操作系统。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/cloudservers/{instance_id}/change-os

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

边缘实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

image_id

是

String

切换系统所使用的新镜像的ID。

metadata

否

ChangeOsMetadata object

切换系统的元数据。

key_name

否

String

密钥对名称。 如果需要使用SSH密钥方式登录边缘实例，请指定已创建密钥的名称。

最小长度：1

最大长度：64
表4 ChangeOsMetadata

参数

是否必选

参数类型

描述

user_data

否

String

切换边缘实例操作系统过程中注入的用户数据。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

job_id

String

提交任务成功后返回的任务ID，用户可以使用该ID对任务执行情况进行查询。

请求示例

切换实例操作系统

POST https://{endpoint}/v1/cloudservers/d10f846a-d7a4-4ee7-9552-19f656d898e6/change-os

{
  "image_id" : "dfb293e2-bf24-11ea-8ca8-fa1640495574"
}

响应示例

状态码： 200

OK

{
  " job_id" : "70a599e0-31e7-49b7-b260-868f441e862b"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 边缘实例

相关文档