镜像内置应用 CreateImageOneStep--云手机-火山引擎

文档中心

立即注册

导航

云手机

镜像内置应用 CreateImageOneStep

最近更新时间：2024.05.08 16:33:53首次发布时间：2024.05.08 16:33:53

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

使用说明

内置应用和文件需按照固定格式以压缩包的形式提供。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=CreateImageOneStep&Version=2023-10-30

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateImageOneStep`	接口名称。当前 API 的名称为 `CreateImageOneStep`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1591495366954xxxxxx`	云手机业务ID，可在「云手机控制台-业务管理-业务详情」中获取。
ImageId	String	是	`test_image`	镜像 ID，作为构建自定义镜像的基线或基准镜像。
ImageName	String	否	`测试镜像`	镜像名称，由用户自定义，用于业务标识。支持英文、中文字符、数字和下划线，需以英文或中文开头，长度不超过 128 个字符。如不指定，则使用默认名称，格式为 “公共镜像 ID+AOSP 镜像版本+账号 ID+自定义镜像”。
ImageAnnotation	String	否	`测试镜像`	镜像描述信息，由用户按需添加镜像备注说明，便于业务识别。
FileUrl	String	否	`http://file.bytetos.com/cloudphone/file.zip`	需要内置的应用或文件的下载地址；内置的文件需按照固定格式提供整体压缩包文件，文件名需为 `file.zip`。详请参考预置应用或文件上传说明。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
TaskId	String	`7294157141458xxxxxx`	应用安装任务 ID，用于通过 `GetTaskInfo` 接口查看任务执行状态及结果。
TaskAction	String	`CreateImageOneStep`	任务类型，此处为 `CreateImageOneStep`。

请求示例

POST https://open.volcengineapi.com?Action=CreateImageOneStep&Version=2023-10-30
{
    "ProductId": "1591495366954xxxxxx",
    "ImageId": "test_image",
    "ImageName": "测试镜像",
    "ImageAnnotation": "测试镜像",
    "FileUrl": "http://file.bytetos.com/cloudphone/file.zip"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "CreateImageOneStep",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "TaskId": "7294157141458xxxxxx",
        "TaskAction": "CreateImageOneStep"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。