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

文档中心

立即注册

导航

下载文件 PullFile

最近更新时间：2024.05.09 17:19:40首次发布时间：2022.04.21 18:01:57

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

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	PullFile
Version	Query	String	是	公共参数，OpenAPI 接口版本	2020-10-25

Body 参数

字段	类型	必填	说明
product_id	String	是	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
instance_id	String	是	实例 ID
file_path	String	是	文件在云机实例中的存储地址，例如：`/sdcard/mp4/record.mp4`
tos_info	Map	是	保存源文件的火山引擎对象存储信息，参考以下 TosInfo 结构说明注：访问火山引擎对象存储中的文件，需要为接口开通访问权限。详细信息，参考常见问题中的说明

TosInfo 结构说明

字段	类型	必填	说明
tos_bucket	String	是	火山引擎对象存储中的存储桶名称，例如：`test-bucket`
tos_file_path	String	是	存储桶下的目录和文件名称（不能以 / 开头），例如：`cloudphone/screen_record/run_tag1.mp4`
endpoint	String	是	火山引擎对象存储服务地址（地域节点），若为空，则使用默认值：`tos-cn-beijing.volces.com`
region	String	是	火山引擎对象存储服务区域，若为空，则使用默认值：`cn-beijing`

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
job_id	String	任务 ID，用于通过调用 GetJobDetails 接口，获取任务执行结果

示例

请求示例

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

{
    "product_id": "14677396781xxxxxxxx",
    "instance_id": "i-1726334685xxxxxx",
    "file_path": "/sdcard/mp4/record.mp4",
    "tos_info": {
        "tos_bucket": "test-bucket",
        "tos_file_path": "cloudphone/screen_record/run_tag1.mp4",
        "endpoint": "tos-cn-beijing.volces.com",
        "region": "cn-beijing"
    }
}

返回示例

{
    "ResponseMetadata": {
        "Action": "PullFile",
        "Region": "cn-north-1",
        "RequestId": "202203091551430101940340380F0B95C8",
        "Service": "iPaaS",
        "Version": "2020-10-25"
    },
    "Result": {
        "job_id": "req-70727002789xxxxxxxx"
    }
}