You need to enable JavaScript to run this app.
导航
创建镜像
最近更新时间:2023.07.12 10:21:51首次发布时间:2022.11.23 10:27:19

本接口用于通过边缘实例创建镜像。

接口说明

  • 用于创建镜像的边缘实例需处于已停止stop)状态。此外,在镜像创建过程中,该实例须一直处于已停止状态。
  • 一个火山引擎账号最多允许制作和导入 5 个自定义镜像。如果需要创建更多的自定义镜像,请提交工单申请。

请求方法

POST

请求参数

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

名称

类型

是否必选

示例值

描述

Action

String

BuildImageByVM

公共参数。该参数表示接口名称。取值:BuildImageByVM。

Version

String

2021-04-30

公共参数。该参数表示接口版本。取值:2021-04-30。

veen_vm_id

String

veen1128038002028123****

用于创建镜像的边缘实例的 ID。您可以通过 ListInstances 接口查询边缘实例 ID。

image_name

String

myimage

镜像名称。命名规则如下:

  • 允许 5~80 个字符。
  • 支持中文、大写字母、小写字母、数字。
  • 支持特殊字符 ()`~!@#$%^&*-+=_|{}[]:;'<>,.?/。
  • 不能包含双引号(")、反斜线( \)和空格,且不能以正斜线(/)开头。

description

String

test

镜像的描述信息。

返回数据

名称

类型

示例值

描述

image_id

String

image6gb5xg****

镜像 ID。

请求示例

POST https://veenedge.volcengineapi.com/?Action=BuildImageByVM&Version=2021-04-30
&<其他公共参数>
{
  "veen_vm_id": "veen2011039290250111****",
  "image_name": "myimage"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230530194903C7AF8E9C0EA04DDE****",
        "Action": "BuildImageByVM",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "image_id": "imagesttfiy****"
    }
}

错误码

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