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

从指定云手机实例下载文件或文件夹到对象存储(异步任务)。调用说明如下:

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

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

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段
类型
必填
说明
product_idString业务 ID,可在「云手机控制台-业务管理-业务详情」中获取
pod_idString实例 ID

file_path

String

实例中待下载文件的路径或文件名,支持从以下路径下载文件:

  • /sdcard/

  • /data/misc/logd/ + 日志文件名/

tos_bucketString火山引擎对象存储中的存储桶名称,例如:test-bucket

tos_file_path

String

存储桶下保存文件的完整路径,包括文件名,并且指定的路径必须存在(不能以 / 开头),例如:cloudphone/screen_record/record.mp4

说明:当下载文件夹时,会将文件夹以 .zip 文件的格式下载,tos_file_path 也要指定为以 .zip 文件格式结尾

endpointString对象存储服务地址,例如:tos-cn-beijing.volces.com
regionString对象存储服务区域,例如:cn-beijing

返回结果

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

Result 字段包含以下参数:

字段
类型
说明

task_id

String

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

task_actionString任务类型,此处为 PullFile

示例

请求示例

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

{
    "product_id":"1608456935646xxxxxx",
    "pod_id":"7299381659819xxxxxx",
    "file_path":"/data/misc/logd",
    "tos_bucket":"my-bucket",
    "tos_file_path":"files/download.zip",
    "endpoint":"tos-cn-beijing.volces.com",
    "region":"cn-beijing"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "PullFile",
        "Region": "cn-north-1",
        "RequestId": "20231114180546026C4EEFB0108B23F48B",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "task_id": "7301255941591xxxxxx",
        "task_action": "PullFile"
    }
}

错误码

错误码说明操作建议
30000000对象存储错误参考接口参数说明,检查指定的对象存储信息是否正确
30000001Tos错误参考接口参数说明,检查是否已开通对象存储的访问权限
30000003申请临时AK、SK错误参考 附件 中的说明,检查是否已为账号授予相关权限
30000004火山引擎对象存储文件信息错误参考接口参数说明,检查指定的对象存储文件信息是否正确