分发文件至实例 DistributeFile--云手机-火山引擎

文档中心

立即注册

导航

云手机

分发文件至实例 DistributeFile

最近更新时间：2025.06.03 14:22:38首次发布时间：2024.05.20 14:17:51

该接口用于将文件或应用快速分发至云手机实例指定目录下。支持跨区域、跨集群的多实例文件分发。
你可以通过 GetTaskInfo 接口查询分发任务执行结果详细信息。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1696164119863xxxxxx`	实例所归属的业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
PodIdList	Array of String	是	`["7366133767813xxxxxx","7366133767813xxxxxx","7359192141879xxxxxx"]`	实例 ID 列表，指定该参数时，对多个实例批量执行文件分发操作。支持批量操作的实例数上限为 100。
FileName	String	是	`testapp.tar.gz`	需要保存在实例内的文件名称。注意此处需传入带有文件格式的完整文件名。
FileMd5	String	是	`854ef5c91ea6dc5c4705133330xxxxxx`	文件 md5 值。
DownloadUrl	String	是	`https://xxx.tos-cn-beijing.volces.com/test.apk`	文件下载链接。
TargetDirectory	String	是	`/sdcard/data/files`	目标存储路径。
AutoUnzip	Integer	否	`0`	分发 `zip` 或 `tgz` 格式的压缩文件至云手机后，是否自动解压缩文件： 0：（默认设置）不自动解压文件； 1：自动解压文件。

返回参数

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

参数	类型	示例值	描述
TaskId	String	`7366179593021xxxxxx`	分发文件任务 ID。
TaskAction	String	`DistributeFile`	任务类型。

请求示例

POST https://open.volcengineapi.com?Action=DistributeFile&Version=2023-10-30
{
    "ProductId": "1696164119863xxxxxx",
    "PodIdList": [
        "7366133767813xxxxxx",
        "7366133767813xxxxxx",
        "7359192141879xxxxxx"
    ],
    "FileName": "testapp.tar.gz",
    "FileMd5": "854ef5c91ea6dc5c4705133330xxxxxx",
    "DownloadUrl": "https://xxx.tos-cn-beijing.volces.com/test.apk",
    "TargetDirectory": "/sdcard/data/files",
    "AutoUnzip": 0
}

返回示例

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

错误码

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