上传文件 PushFile--云手机-火山引擎

文档中心

立即注册

导航

上传文件 PushFile

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

从对象存储或下载链接推送文件到一个或多个云手机实例（异步任务）。

使用说明

当前仅支持火山引擎对象存储。访问火山引擎对象存储中的文件，需要为接口开通访问权限。详细信息，参考附件中的说明。
文件推送结果通过回调返回，详细信息，参考回调服务接入指南。
如果当前文件推送任务尚未完成，继续调用该接口时，会在文件上传完成后开始第二个文件推送任务。最多支持 200 个文件推送任务排队。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1608456935646xxxxxx`	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
PodIdList	Array of String	是	`["7299381659819xxxxxx"]`	需要推送文件的实例 ID 列表，长度上限为 200。
TosBucket	String	否	`my-bucket`	从对象存储推送文件到云手机实例，指定保存源文件的火山引擎对象存储中的存储桶名称，例如：`test-bucket`。说明：与 `DownloadUrl` 二选一，如果 `TosBucket` 填写，则会忽略 `DownloadUrl`参数。
TosFilePath	String	否	`files/file01.pdf`	（TosBucket 填写时，必填）存储桶下的目录或文件名称（不能以 / 开头），正确示例：`cloudphone/gameApk/my_photo.jpg`。
Endpoint	String	否	`tos-cn-beijing.volces.com`	（TosBucket 填写时，必填）对象存储服务地址，例如：`tos-cn-beijing.volces.com`。
Region	String	否	`cn-beijing`	（TosBucket 填写时，必填）对象存储服务区域，例如：`cn-beijing`。
DownloadUrl	String	否		从下载链接推送文件到云手机实例。与 TOS 上传二选一，如果 `TosBucket`为空则此参数生效。
FileName	String	否		推送文件的文件名：如果通过下载链接（DownloadUrl）推送文件，则必填；如果通过火山引擎对象存储（TOS）推送文件，则非必填。说明：如重复上传同名文件，已有文件将被覆盖。
TargetDirectory	String	是	`/data/local/`	推送文件至云手机实例中的目标路径（不包括文件名），支持的目标路径包括以下目录： /sdcard/ /data/local/
AutoUnzip	Integer	否	`1`	是否自动解压推送的压缩文件： 0：推送 zip 文件后，自动解压文件（默认）； 1：推送 zip 文件后，不自动解压文件。

返回参数

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

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

请求示例

POST https://open.volcengineapi.com?Action=PushFile&Version=2023-10-30
{
    "ProductId": "1608456935646xxxxxx",
    "PodIdList": [
        "7299381659819xxxxxx"
    ],
    "TosFilePath": "files/file01.pdf",
    "Endpoint": "tos-cn-beijing.volces.com",
    "Region": "cn-beijing",
    "TosBucket": "my-bucket",
    "TargetDirectory": "/data/local/",
    "AutoUnzip": 1
}

返回示例

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

错误码

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