创建实例的应用镜像，以便后续快速部署相同的应用环境。 ## 注意事项若您使用 2026 年 9 月 2 日及之后发布的 AOSP 10、AOSP 13 镜像版本，支持通过本接口将 XAPK 格式的应用安装包打包为镜像压缩包。 ## 请求说明 * 请求方式：POST * 请求地址：https://open.volcengineapi.com?Action=CreateAppImage&Version=2025\-05\-01 ## 请求参数下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见 [公共参数](https://www.volcengine.com/docs/6369/67268)。 ### Query |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Action |String |是 |CreateAppImage |接口名称。当前 API 的名称为 `CreateAppImage`。 | |Version |String |是 |2025\-05\-01 |接口版本。当前 API 的版本为 `2025-05-01`。 | ### Body |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |ProductId |String |是 |1749281594201\*\*\* |业务 ID，管理云手机资源、开展云手机业务的标识。您可以登录 [云手机控制台](https://console.volcengine.com/ACEP/Business/5)，在已创建的业务卡片中获取。 | |PodId |String |是 |7332828319227\*\*\* |实例 ID，您可以通过调用 [ListPod](https://docs.volcengine.com/docs/6394/2304643) 接口获取。 | |PackageNameList |Array of String |是 |["com.test.app1","com.android.test2"] |实例上需要打包的应用包名列表，以 `,` 分隔。需确保应用已经正常安装。如应用未完成安装，则会导致任务部分失败。 | |LocalPath |String |否 |/data/app_images/nfs |镜像在本地的存储路径。指定路径后，打包完成的镜像将保存至该目录，供同机房内直接共享分发。为空时表示不保留本地镜像，上传完成后自动清理本地文件。

说明

本地镜像以目录形式存储，云端镜像以压缩包形式存储，默认格式为.tar.gz（打包并压缩文件）。

| |ImageMode |String |否 |Private |应用镜像可部署范围，取值：

* `Public`：共享模式，允许部署在同一账户下不同业务的实例中。

* `Private`：（默认值）非共享模式，仅允许部署在某一业务的实例中。 | |CompressFormat |Integer |否 |0 |应用镜像的打包格式，取值：

* `0`：`.tar.gz` 格式，打包后进行 gzip 压缩，文件体积更小。

* `1`：（默认值）`.tar` 格式，仅打包不压缩。 | ## 返回参数下表仅列出本接口特有的返回参数。更多信息请参见 [返回结构](https://www.volcengine.com/docs/6394/75748#%E8%BF%94%E5%9B%9E%E7%BB%93%E6%9E%9C)。 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |TaskId |String |160845693564\*\*\* |应用镜像任务 ID。 | |TaskAction |String |CreateAppImage |任务操作类型。调用本接口时，该字段固定返回 `CreateAppImage`，表示创建应用镜像操作。 | |Jobs |Array of [Job](https://docs.volcengine.com/docs/6394/2610035#job) |\- |操作的子任务列表。 | ### Job |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |JobId |String |job\-7294170061873\*\*\*\-7294157141458\*\*\* |子任务 ID，每个子任务 ID 对应一个实例。 | |PodId |String |7294157141458\*\*\* |子任务对应的目标实例 ID。 | |HostId |String |7337159054625\*\*\* |目标实例所在的云机 ID。 | |Status |Integer |100 |子任务的执行状态码。`100` 表示执行成功，其他状态码请参见 [子任务状态码说明](https://docs.volcengine.com/docs/6394/1386614#mJSkQbVY)。 | |JobAction |String |CreateAppImage |子任务的具体操作类型，该字段固定返回 `CreateAppImage`，表示创建应用镜像操作。 | |JobMessage |String |应用镜像创建成功 |子任务信息，记录任务执行过程中或执行完成后产生的相关内容。 | |PackageName |String |com.android.test1 |已打包的应用程序包名。 | ## 请求示例 ```JSON POST https://open.volcengineapi.com?Action=CreateAppImage&Version=2025-05-01 { "ProductId": "1749281594201***", "PodId": "7332828319227***", "PackageNameList": [ "com.test.app1", "com.android.test2" ], "LocalPath": "/data/app_images/nfs", "ImageMode": "Private", "CompressFormat": 0 } ``` ## 返回示例 ```JSON { "ResponseMetadata": { "Action": "CreateAppImage", "Region": "cn-north-1", "Service": "ACEP", "Version": "2025-05-01", "RequestId": "20230604110420****100232280022D31" }, "Result": { "TaskId": "160845693564***", "TaskAction": "CreateAppImage", "Jobs": [ { "JobId": "job-7294170061873***-7294157141458***", "PodId": "7294157141458***", "HostId": "7337159054625***", "Status": 100, "JobAction": "CreateAppImage", "JobMessage": "应用镜像创建成功", "PackageName": "com.android.test1" } ] } } ``` ## 错误码您可访问 [公共错误码](https://www.volcengine.com/docs/6394/1134303)，获取更多错误码信息。