【旧版】镜像内置应用 CreateImageOneStep--云手机-火山引擎

文档中心

立即注册

导航

【旧版】镜像内置应用 CreateImageOneStep

最近更新时间：2024.06.17 19:36:23首次发布时间：2023.11.17 17:55:38

基于已有镜像，快速构建内置应用和文件的自定义镜像（异步任务）。

接口使用说明：内置应用和文件需按照固定格式以压缩包的形式提供。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
product_id	String	是	云手机业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
image_id	String	是	镜像 ID，作为构建自定义镜像的基线或基准镜像，可通过调用 ListContainerImages 接口获取（也可传入镜像地址）
image_name	String	否	镜像名称，由用户自定义，用于业务标识（支持英文、中文字符、数字和下划线，需以英文或中文开头，长度不超过128个字符；如不指定，则使用默认名称，格式为 “公共镜像ID+AOSP镜像版本+账号ID+自定义镜像”）
image_annotation	String	否	镜像描述信息，由用户按需添加镜像备注说明，便于业务识别
file_url	String	是	需要内置的应用或文件的下载地址；内置的文件需按照固定格式提供整体压缩包文件，文件名需为 `file.zip`；详细信息，参考以下文件打包说明

文件打包说明

准备需要打包的文件，并确定文件需要内置到镜像内的目录，参考以下说明：

目录	说明
/system/framework	该目录用于存放资源型应用（系统框架）
/system/app	该目录用于存放系统级应用，目录下的应用能获取到比较高的权限，应用不可卸载
/system/priv-app	该目录是从 Android 4.4 开始出现的目录，用于存放系统核心应用，能获取到比 system/app/ 下应用更高的权限；应用不可卸载，如：Setting、SystemUI等
/vendor/app	该目录用于存放厂商的一些应用，不可卸载

定义需要保存应用的文件夹（文件夹名称可自定义，但后续镜像更新时需要保持一致），并将需要打包的文件拷贝到对应的目录下，参考以下示例：
```
/system/priv-app/GoogleFramework/GoogleFramework.apk
/system/priv-app/GoogleFramework/lib/arm64/
```
注意：需要确保目录和文件层级准确无误。内置到 system 分区的文件，最外层文件夹一定是 system；内置到 vendor 分区的文件，最外层文件夹一定是 vendor。参考以下示例：
需要内置的文件准备完成后，将 system 文件夹和 vendor 文件夹（若有）一起打包成 file.zip 文件。参考以下示例：

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
task_id	String	任务 ID，用于通过任务信息查询接口查看任务执行状态及结果
task_action	String	任务类型，默认为对应接口 Action 名称，此处为 CreateImageOneStep

示例

请求示例

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

{
  "product_id": "测试镜像",
  "image_id": "test_image",
  "image_name": "测试镜像",
  "image_annotation": "测试镜像",
  "file_url": "http://file.bytetos.com/cloudphone/file.zip"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "CreateImageOneStep",
        "Region": "cn-north-1",
        "RequestId": "20231026145818222B0460DEA2E06713F3",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "task_id": "7294157141458xxxxxx",
        "task_action": "CreateImageOneStep"
    }
}