You need to enable JavaScript to run this app.
导航
【旧版】推送文件 PushFile
最近更新时间:2024.06.17 19:36:20首次发布时间:2023.06.14 12:45:18
复制全文
我的收藏
有用
有用
无用
无用

从对象存储或下载链接推送文件到一个或多个云手机实例(异步任务)。调用说明如下:

  • 当前仅支持火山引擎对象存储。访问火山引擎对象存储中的文件,需要为接口开通访问权限。详细信息,参考 附件 中的说明。

  • 文件推送结果通过回调返回,详细信息,参考 回调服务接入指南

  • 如果当前文件推送任务尚未完成,继续调用该接口时,会在文件上传完成后开始第二个文件推送任务(最多支持100个文件推送任务排队)。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称PushFile
VersionQueryString公共参数,OpenAPI 接口版本2022-08-01

Body 参数

字段
类型
必填
说明
product_idString业务 ID,可在「云手机控制台-业务管理-业务详情」中获取
pod_id_listString[]需要推送文件的实例 ID 列表

tos_bucket

String

从对象存储推送文件到云手机实例,指定保存源文件的火山引擎对象存储中的存储桶名称,例如:test-bucket

说明:与download_url二选一,如果tos_bucket填写,则会忽略download_url参数

tos_file_pathString(tos_bucket填写时,必填)存储桶下的目录或文件名称(不能以 / 开头),例如:cloudphone/gameApk/my_photo.jpg
endpointString(tos_bucket填写时,必填)对象存储服务地址,例如:tos-cn-beijing.volces.com

region

String

(tos_bucket填写时,必填)对象存储服务区域,例如:cn-beijing

download_url

String

从下载链接推送文件到云手机实例(与tos上传二选一,如果tos_bucket为空则生效)

file_name

String

推送文件的文件名:

  • 如果通过下载链接(download_url)推送文件,必填

  • 如果通过火山引擎对象存储(tos)推送文件,非必填

说明:如重复上传同名文件,已有文件将被覆盖

target_directory

String

推送文件至云手机实例中的目标路径(不包括文件名),支持的目标路径包括以下目录:

  • /sdcard/

  • /data/local/

auto_unzip

Int32

是否自动解压推送的压缩文件:

  • 0:推送zip文件后,自动解压文件(默认)

  • 1:推送zip文件后,不自动解压文件

返回结果

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

Result 字段包含以下参数:

字段
类型
说明

task_id

String

文件推动任务 ID,用于通过 任务信息查询 接口查看任务执行状态及结果

task_actionString任务类型,此处为 PushFile

示例

请求示例

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

{
    "product_id":"1608456935646xxxxxx",
    "pod_id_list":["7299381659819xxxxxx"],
    "tos_bucket":"my-bucket",
    "tos_file_path":"files/file01.pdf",
    "endpoint":"tos-cn-beijing.volces.com",
    "region":"cn-beijing",
    "target_directory":"/data/local/"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "PushFile",
        "Region": "cn-north-1",
        "RequestId": "202311141756018419E1DC3097D06C0ACC",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "task_id": "7301253504004xxxxxx",
        "task_action": "PushFile"
    }
}

错误码

错误码说明操作建议
30000000对象存储错误参考接口参数说明,检查指定的对象存储信息是否正确
30000001Tos错误参考接口参数说明,检查是否已开通对象存储的访问权限
30000002URL转化签名错误检查文件下载链接是否正确、文件是否可正常下载
30000003申请临时AK、SK错误参考 附件 中的说明,检查是否已为账号授予相关权限
30000004火山引擎对象存储文件信息错误参考接口参数说明,检查指定的对象存储文件信息是否正确
8030011业务存储容量已超过可用上限对业务存储进行扩容操作