【旧版】镜像构建 ImportContainerImage--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】镜像构建 ImportContainerImage

最近更新时间：2024.06.17 19:36:17首次发布时间：2023.06.14 12:45:15

导入基于平台镜像基线改制的自定义镜像文件，构建成自定义镜像。

需联系火山引擎技术支持开通本接口的权限。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ImportContainerImage
Version	Query	String	是	公共参数，OpenAPI 接口版本	2022-08-01

Body 参数

字段	类型	必填	说明
image_name	string	否	镜像名称
image_annotation	string	否	镜像备注信息
image_file_type	string	否	镜像文件类型及来源，不填默认为 volc_tos，枚举值选项： volc_tos（从火山引擎的TOS对象存储中拉取文件） url（从第三方对象存储服务拉取文件，当前已支持阿里云OSS）
image_url_info	ImageLoadUrl	否	存储在第三方对象储存服务中的镜像文件信息，详细信息，参考 ImageLoadUrl 定义（当 image_file_type 传值是 url 时，该结构体信息为必填项）
image_tos_info	TosImageInfo	否	存储在火山引擎对象存储系统中的原始镜像信息，详细信息，参考 TosImageInfo 定义（当 image_file_type 传值是 volc_tos 时，该结构体信息为必填项）

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
image_id	string	镜像 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=ImportContainerImage
&Version=2022-08-01
&<通过header传入的公共请求参数>

{
  "image_annotation": "测试镜像",
  "image_name": "test_image",
  "image_file_type": "volc_tos",
  "image_tos_info": {
    "region": "cn-beijing",
    "endpoint": "tos-cn-beijing.volces.com",
    "bucket": "iamges-bucket",
    "system_img": {
      "file_path": "system.img"
    },
    "vendor_img": {
      "file_path": "vendor.img"
    }
  }
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ImportContainerImage",
        "Region": "cn-north-1",
        "RequestId": "20231101102513DF03CC59A8AF1AE2B84B",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "image_id": "img-158xxxxxx"
    }
}

错误码

错误码	说明
21340	镜像构建异常	参考接口文档，检查镜像资源文件信息是否正确
21341	镜像构建进程异常	参考接口文档，检查镜像资源文件信息是否正确
21342	镜像构建任务不存在	检查镜像构建任务 ID 是否正确
21350	镜像仓库异常	确保镜像仓库正常可用