上传应用 UploadApp--云手机-火山引擎

文档中心

立即注册

导航

上传应用 UploadApp

最近更新时间：2025.11.03 17:18:49首次发布时间：2024.05.08 16:08:11

上传应用安装文件到应用管理中心（异步任务）。

使用说明

应用上传结果通过任务执行回调返回，详细信息，参考云手机回调服务接入指南。

注：该接口增加并发量限制，上限 10 路并发，更多并发请求将被平台拒绝（错误码：8050005）。

注意事项

本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	否	`1641133322660xxxxxx`	应用上传的目标业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。注意若指定 AppMode 为 Private，则该参数必填。
AppId	String	否	`app01`	应用 ID。如不指定，则自动生成；如指定，需保证应用 ID 在账号下唯一。
AppName	String	否	`Chess`	应用名称，如不填写，则默认返回空值。
AppType	Integer	是	`2`	应用类型： `0`：其他 `1`：视频 `2`：游戏 `3`：效率 `4`：办公
Rotation	Integer	否	`0`	应用的横竖屏： `0`：竖屏 `270`：横屏
UploadType	Integer	否	`0`	上传方式，目前仅支持设为 0，即 HTTP 下载地址。
DownloadUrl	String	是	`https://mybucketxxx.tos-cn-beijing.volces.com/chess.apk`	应用下载 URL 地址。
AppDesc	String	否	`棋类游戏`	应用描述。
ParseFlag	Integer	否	`0`	应用文件解析类型： `0`，解析；向前兼容，默认解析并且转存到火山引擎对象存储 `1`，不解析，透传地址，不转存到火山引擎对象存储
ExtraInfo	Object of AppUploadExtra	否	`-`	应用信息，参考以下 AppUploadExtra数据结构说明。
AppMode	String	否	`Public`	应用可安装范围： `Public`：应用设为共享模式，允许在同一个账户下不同业务的实例中安装； `Private`：默认设置，应用设为非共享模式，仅允许在某一业务的实例中安装。

AppUploadExtra

参数	类型	是否必选	示例值	描述
Md5	String	否	`196f0d876ba9c5555889ed81e5xxxxxx`	文件 md5 值。
PackageName	String	否	`com.ss.android.ugc.xxx`	应用包名。
VersionCode	Integer	否	`260301`	应用版本号。
VersionName	String	否	`26.3.0`	应用版本名称

返回参数

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

参数	类型	示例值	描述
TaskId	String	`7296791527953xxxxxx`	应用上传任务 ID，可用于通过 `GetTaskInfo`接口查看任务执行状态及结果。
TaskAction	String	`UploadApp`	任务类型。

请求示例

POST https://open.volcengineapi.com?Action=UploadApp&Version=2023-10-30
{
    "ProductId": "1641133322660xxxxxx",
    "AppId": "app01",
    "AppName": "Chess",
    "AppType": 2,
    "Rotation": 0,
    "UploadType": 0,
    "DownloadUrl": "https://mybucketxxx.tos-cn-beijing.volces.com/chess.apk",
    "AppDesc": "棋类游戏",
    "ParseFlag": 0,
    "ExtraInfo": {
        "Md5": "196f0d876ba9c5555889ed81e5xxxxxx",
        "PackageName": "com.ss.android.ugc.xxx",
        "VersionCode": 260301,
        "VersionName": "26.3.0"
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "UploadApp",
        "Version": "2023-10-30",
        "Service": "ACEP",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskAction": "UploadApp",
        "TaskId": "7296791527953xxxxxx"
    }
}

错误码

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