You need to enable JavaScript to run this app.
导航
边缘计算节点
  • 文档首页
    • /
  • 边缘计算节点

导入镜像

最近更新时间：2023.07.03 16:32:41

首次发布时间：2022.11.23 10:27:19

我的收藏

本接口用于导入镜像。

接口说明

前提条件：

  • 已创建自定义镜像。
  • 已遵循镜像导入规范。详情请参考镜像导入规范。

使用限制：

  • 一个火山引擎账号最多允许制作和导入 5 个自定义镜像。如果需要创建更多的自定义镜像，请提交工单或联系客服人员。
  • 仅支持以下格式的镜像：RAW、QCOW2、VHDX 和 VMDK。
  • 导入的镜像的大小默认不能超过 50GB。
  • Windows 镜像的系统盘只能使用 MBR 分区和 NTFS 文件系统。
  • Linux 镜像的系统盘只能使用 MBR 分区和 ext3/4 文件系统。
  • 须保持操作系统的原生内核。如果修改了内核，镜像将无法成功导入。

请求方法

POST

请求参数

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

名称

类型

是否必选

示例值

描述

Action

String

是

UploadURLImage

公共参数。该参数表示接口名称。取值：UploadURLImage。

Version

String

是

2021-04-30

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

image_name

String

是

newimage

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

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

url

String

是

your.image.com

上传的镜像的地址。

system_arch

String

是

Linux

操作系统。取值范围：

  • Linux：Linux操作系统。
  • Windows：Windows操作系统。

system_bit

String

是

64

系统架构。取值范围：

  • 32：32位操作系统。
  • 64：64位操作系统。

system_type

String

是

CentOS

系统平台。取值范围：
Linux：

  • CentOS
  • Ubuntu
  • Debian

Windows：

  • Windows

system_version

String

是

8.3

镜像系统版本。取值范围：
CentOS：

  • 6.9
  • 7.2
  • 7.3
  • 7.4
  • 7.5
  • 7.6
  • 7.8
  • 7.9
  • 8.3

Debian：

  • 9
  • 10

Ubuntu：

  • Server 16.04 LTS
  • Server 18.04 LTS
  • Server 20.04 LTS

Windows：

  • 10
  • 2012 R2 STD 标准版
  • 2016 STD 标准版
  • 2019 STD 标准版

disk_size

Integer

是

50

系统盘大小。该参数值代表您在使用该镜像创建边缘实例时，系统盘可选的最小值。单位：GB。取值范围：50~100。该参数值须为 10 的倍数。

description

String

否

This is a new image

镜像的描述信息。

返回数据

无

请求示例

POST https://veenedge.volcengineapi.com/?Action=UploadURLImage&Version=2021-04-30
&<其他公共参数>
{
  "image_name": "myimage",
  "url": "https://example.com",
  "system_arch": "Linux",
  "system_bit": "32",
  "system_type": "CentOS",
  "system_version": "8.3",
  "disk_size": 50
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306062001317906489B3CEC4E53****",
        "Action": "UploadURLImage",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

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