导入基于平台镜像基线改制的自定义镜像文件,构建成自定义镜像。
使用 POST 方式发起请求。
下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考 公共请求参数。
字段 | 位置 | 类型 | 必填 | 说明 | 值 |
---|---|---|---|---|---|
Action | Query | String | 是 | 公共参数,OpenAPI 接口名称 | ImportContainerImage |
Version | Query | String | 是 | 公共参数,OpenAPI 接口版本 | 2020-10-25 |
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
image_name | String | 否 | 镜像名称,由用户自定义,用于业务标识,128个英文或中文字符及以内,需以英文或中文开头,可以包含数字、下划线 |
image_annotation | String | 否 | 镜像描述信息,由用户按需添加镜像备注说明,便于业务识别 |
image_file_type | String | 否 | 镜像文件类型及来源,可选项:
|
image_url_info | Object | 否 | 存储在第三方对象储存服务中的镜像文件信息,详细信息,参考以下 UrlInfo 结构说明(当 image_file_type 传值是 url 时,该结构体信息为必填项) |
image_tos_info | Object | 否 | 存储在火山引擎对象存储系统中的原始镜像信息,详细信息,参考以下 TosInfo 结构说明(当 image_file_type 传值是 volc_tos 时,该结构体信息为必填项) |
UrlInfo 结构说明
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
system_img | Object | 是 | AOSP 镜像 system 分区原始镜像信息,参考以下 ImageInfo 结构说明 |
vendor_img | Object | 是 | AOSP 镜像 vendor 分区原始镜像信息,参考以下 ImageInfo 结构说明 |
ImageInfo 结构说明:
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
url | String | 是 | 镜像文件所在第三方对象存储中的路径或地址 |
md5 | String | 否 | 镜像文件的 MD5,不填则不校验 |
TosInfo 结构说明
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
region | String | 是 | 对象存储所在区域:
|
endpoint | String | 是 | 镜像文件所在 TOS 的 endpoint,例如:tos-cn-beijing-volces.com |
bucket | String | 是 | 镜像文件所在 TOS 的 bucket,例如:cloudphone |
system_img | ImageInfo | 是 | AOSP 镜像 system 分区原始镜像信息,参考以下 ImageInfo 结构说明 |
vendor_img | ImageInfo | 是 | AOSP 镜像 vendor 分区原始镜像信息,参考以下 ImageInfo 结构说明 |
ImageInfo 结构说明:
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
file_path | String | 是 | 镜像文件在 TOS 中的存储路径(不能以 / 开头),例如: android-image-build/system.img |
md5 | String | 否 | 镜像文件的 MD5,不填则不校验 |
通用返回参数,请参考 ResponseMetadata 结构说明。
Result 字段包含以下参数:
字段 | 类型 | 说明 |
---|---|---|
image_id | String | 镜像构建成功,返回镜像 ID |