【旧版】应用上传 UploadApp--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】应用上传 UploadApp

最近更新时间：2024.06.17 19:36:19首次发布时间：2023.06.14 12:45:17

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

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

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

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
product_id	string	是	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
app_id	string	否	自定义应用 ID：如不指定，则自动生成如指定，业务方需保证应用 ID 在业务维度唯一
app_name	string	否	应用名称，如不填写，则默认返回空值
app_type	int32	是	应用类型： 0 => 其他 1 => 视频 2 => 游戏 3 => 效率 4 => 办公
rotation	int32	否	应用的横竖屏： 0 => 竖屏 270 => 横屏
upload_type	int32	是	上传方式： 0 => HTTP 下载地址
download_url	string	是	应用下载 URL 地址
app_desc	string	否	应用描述
parse_flag	int32	否	应用文件解析类型： 0，解析；前向兼容，默认解析并且转存到火山引擎对象存储 1，不解析，透传地址，不转存到火山引擎对象存储
extra_info	AppBrief	否	应用信息，参考以下 AppBrief 结构说明

AppBrief 结构说明

字段	类型	必填	说明
package_name	string	是	应用包名
md5	string	是	文件 md5
version_code	int32	是	应用版本号
version_name	string	否	应用版本名称

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
task_id	string	应用上传任务 ID，用于通过任务信息查询接口查看任务执行状态及结果
task_action	string	任务类型

示例

请求示例

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

{
    "product_id":"1641133322660xxxxxx",
    "app_id":"app01",
    "app_name":"Chess",
    "app_type":2,
    "rotation":0,
    "upload_type":0,
    "download_url":"https://mybucketxxx.tos-cn-beijing.volces.com/chess.apk",
    "app_desc":"棋类游戏",
    "parse_flag":0
}

返回示例

{
    "ResponseMetadata": {
        "Action": "UploadApp",
        "Region": "cn-north-1",
        "RequestId": "20231102172029965E1A56B884881E6E51",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "task_id": "7296791527953816347",
        "task_action": "UploadApp"
    }
}

错误码

错误码	说明	操作建议
8030002	业务不存在	检查指定的业务 ID 是否正确
8030010	所属业务欠费关停	确保业务下的资源订单按时充值付费
8050005	操作的实例数量超过批量操作上限	参考说明文档，检查可批量执行的实例数量上限，建议减少并发请求