下载文件 PullFile--云手机-火山引擎

文档中心

立即注册

导航

云手机

下载文件 PullFile

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

从指定云手机实例下载文件或文件夹到对象存储（异步任务）。

使用说明

当前仅支持火山引擎对象存储。访问火山引擎对象存储中的文件，需要为接口开通访问权限。详细信息，参考附件中的说明。
文件推送结果通过回调返回，详细信息，参考回调服务接入指南。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1608456935646xxxxxx`	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
PodId	String	是	`7299381659819xxxxxx`	实例 ID，可通过调用 `ListPod` 接口获取。
FilePath	String	是	`/data/misc/logd`	实例中待下载文件的路径或文件名，支持从以下路径下载文件： /sdcard/ /data/misc/logd/ + 日志文件名/
TosBucket	String	是	`my-bucket`	火山引擎对象存储中的存储桶名称。
TosFilePath	String	是	`files/download.zip`	存储桶下保存文件的完整路径，包括文件名，并且指定的路径必须存在（不能以 / 开头），例如：`cloudphone/screen_record/record.mp4` 说明：当下载文件夹时，会将文件夹以 .zip 文件的格式下载，`TosFilePath` 也要指定为以 .zip 文件格式结尾。
Endpoint	String	是	`tos-cn-beijing.volces.com`	对象存储服务地址。
Region	String	是	`cn-beijing`	对象存储服务区域。

返回参数

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

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

请求示例

POST https://open.volcengineapi.com?Action=PullFile&Version=2023-10-30
{
    "ProductId": "1608456935646xxxxxx",
    "PodId": "7299381659819xxxxxx",
    "TosBucket": "my-bucket",
    "TosFilePath": "files/download.zip",
    "Endpoint": "tos-cn-beijing.volces.com",
    "Region": "cn-beijing",
    "FilePath": "/data/misc/logd"
}

返回示例

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

错误码

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