You need to enable JavaScript to run this app.
导航
导入自定义镜像 ImportContainerImage
最近更新时间:2024.05.09 17:19:40首次发布时间:2022.10.10 16:27:11

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

请求方式

使用 POST 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称ImportContainerImage
VersionQueryString公共参数,OpenAPI 接口版本2020-10-25

Body 参数

字段
类型
必填
说明
image_nameString镜像名称,由用户自定义,用于业务标识,128个英文或中文字符及以内,需以英文或中文开头,可以包含数字、下划线
image_annotationString镜像描述信息,由用户按需添加镜像备注说明,便于业务识别

image_file_type

String

镜像文件类型及来源,可选项:

  • volc_tos(从火山引擎对象存储拉取文件,默认)
  • url(从第三方对象存储服务拉取文件,需联系火山引擎技术支持做加白处理)
image_url_infoObject存储在第三方对象储存服务中的镜像文件信息,详细信息,参考以下 UrlInfo 结构说明(当 image_file_type 传值是 url 时,该结构体信息为必填项)
image_tos_infoObject存储在火山引擎对象存储系统中的原始镜像信息,详细信息,参考以下 TosInfo 结构说明(当 image_file_type 传值是 volc_tos 时,该结构体信息为必填项)

UrlInfo 结构说明

字段
类型
必填
说明
system_imgObjectAOSP 镜像 system 分区原始镜像信息,参考以下 ImageInfo 结构说明
vendor_imgObjectAOSP 镜像 vendor 分区原始镜像信息,参考以下 ImageInfo 结构说明

ImageInfo 结构说明:

字段
类型
必填
说明
urlString镜像文件所在第三方对象存储中的路径或地址
md5String镜像文件的 MD5,不填则不校验

TosInfo 结构说明

字段
类型
必填
说明

region

String

对象存储所在区域:

  • cn-north => 华北
  • cn-south => 华南
  • cn-east => 华东
  • cn-middle => 华中
endpointString镜像文件所在 TOS 的 endpoint,例如:tos-cn-beijing-volces.com
bucketString镜像文件所在 TOS 的 bucket,例如:cloudphone
system_imgImageInfoAOSP 镜像 system 分区原始镜像信息,参考以下 ImageInfo 结构说明
vendor_imgImageInfoAOSP 镜像 vendor 分区原始镜像信息,参考以下 ImageInfo 结构说明

ImageInfo 结构说明:

字段
类型
必填
说明
file_pathString镜像文件在 TOS 中的存储路径(不能以 / 开头),例如: android-image-build/system.img
md5String镜像文件的 MD5,不填则不校验

返回结果

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

Result 字段包含以下参数:

字段
类型
说明
image_idString镜像构建成功,返回镜像 ID