批量重置系统或更换镜像--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

批量重置系统或更换镜像

最近更新时间：2024.07.08 16:21:04首次发布时间：2023.03.24 15:51:06

本接口用于批量重置指定边缘实例的操作系统或更换边缘实例的镜像。

使用说明

重置系统时，请您注意以下事项：

重置系统的实例需处于已停止（stop）状态。
重置系统后，所选实例的系统盘会恢复到创建时的状态。
如果您在创建实例时设置了自定义数据，重置系统过程中该数据会作为脚本再次执行。
重置系统后，系统盘现存的数据会丢失且无法找回。如需保留系统盘数据，您可以先创建镜像后再重置系统。

更换镜像，请您注意以下事项：

需要更换镜像的实例需处于已停止（stop）状态。
您可以将一个 Linux 镜像更换为其他 Linux 镜像，或者将一个 Windows 镜像更换为其他 Windows 镜像。不允许一个 Linux 镜像与一个 Windows 镜像之间的更换。
如果您在创建实例时设置了自定义数据，该数据会在您更换镜像后作为脚本再次执行。如果新的镜像的类型或版本与原来的镜像不同，该脚本可能会执行失败。如有问题，请提交工单或联系客服人员。
更换镜像后，系统盘现存的数据会丢失且无法找回。如需保留系统盘数据，您可以先创建镜像后再更换镜像。

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com/?Action=BatchResetSystem&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	BatchResetSystem	公共参数。该参数表示接口名称。取值：BatchResetSystem。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。

Body

参数	类型	是否必选	示例值	描述
instance_identities	[]String	是	["veen1020125208252511****"]	边缘实例 ID 列表。您可以通过 ListInstances 接口查询边缘实例 ID。
image_identity	String	否	image****	新镜像的 ID。您可以通过 ListImages 接口查询镜像 ID。该参数用于为边缘实例更换镜像。如果您不指定该参数的值，代表不更换边缘实例的镜像。

返回参数

参数	类型	示例值	描述
failed_instance_identities	[]String	["veen1020125208252511****"]	操作执行失败的边缘实例的 ID。该参数只有在操作执行失败时才会返回。

请求示例

POST https://veenedge.volcengineapi.com/?Action=BatchResetSystem&Version=2021-04-30
&<其他公共参数>
{
  "instance_identities": [
      "veen1020125208252511****",
      "veen2111270501017514****"
    ],
  "image_identity": "imagepnjk4y****"
}

返回示例

正常返回

{
    "ResponseMetadata": {
        "RequestId": "20240306115842D67D87E33AB02AB1****",
        "Action": "BatchResetSystem",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

异常返回

{
    "ResponseMetadata": {
        "RequestId": "202403061157417E19522E35CFBCF8****",
        "Action": "BatchResetSystem",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1",
        "Error": {
            "Code": "BatchResetSystemFailedWithInvalidInstances",
            "Message": "batch reset system failed with invalid instances",
            "CNMessage": "批量重置系统或更换镜像失败，部分实例不支持该操作"
        }
    },
    "Result": {
        "failed_instance_identities": [
            "veen1020125208252511****",
            "veen2111270501017514****"
        ]
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。