tt.uploadFile
收藏我的收藏
收藏基础库 1.0.0 开始支持本方法，这是一个异步方法。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | |
| 注意事项 | |
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
tt
参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| header | object | 否 | 1.0.0 | ||
| formData | object | 否 | 请求额外参数 | 1.0.0 | |
| timeout | number | 否 | 超时时间，单位为毫秒 | 1.0.0 | |
| url | string | 是 | 开发者服务器地址 | 1.0.0 | |
| filePath | string | 是 | 1.0.0 | ||
| name | string | 是 | HTTP 请求的文件名 | 1.0.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 1.0.0 |
header 参数说明
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "uploadFile:ok" | 1.0.0 |
| statusCode | number | 返回 HTTP 状态码 | 1.0.0 |
| profile | object | 网络请求过程中一些调试信息，详情见 Profile 类型说明 | 1.0.0 |
| data | string | object | arraybuffer | 返回数据 | 1.0.0 |
profile 类型说明
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| domainLookupStart | number | DNS 域名查询开始的时间，如果使用了本地缓存（即无 DNS 查询）或持久连接，则与 fetchStart 值相等 | 1.0.0 |
| domainLookupEnd | number | DNS 域名查询完成的时间，如果使用了本地缓存（即无 DNS 查询）或持久连接，则与 fetchStart 值相等 | 1.0.0 |
| connectStart | number | HTTP（TCP） 开始建立连接的时间，如果是持久连接，则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接，则这里显示的是新建立的连接开始的时间 | 1.0.0 |
| connectEnd | number | HTTP（TCP） 完成建立连接的时间（完成握手），如果是持久连接，则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接，则这里显示的是新建立的连接完成的时间。注意这里握手结束，包括安全连接建立完成、SOCKS 授权通过 | 1.0.0 |
| sslConnectionStart | number | SSL 建立连接的时间，如果不是安全连接，则值为 0 | 1.0.0 |
| sslConnectionEnd | number | SSL 建立完成的时间，如果不是安全连接，则值为 0 | 1.0.0 |
| requestStart | number | HTTP 请求读取真实文档开始的时间（完成建立连接），包括从本地读取缓存。连接错误重连时，这里显示的也是新建立连接的时间 | 1.0.0 |
| requestEnd | number | HTTP 请求读取真实文档结束的时间 | 1.0.0 |
| rtt | number | 当次请求连接过程中实时 rtt | 1.0.0 |
| estimateNetType | string | 评估的网络状态 unknown, offline, slow 2g, 2g, 3g, 4g, last/0, 1, 2, 3, 4, 5, 6 | 1.0.0 |
| throughputKbps | number | 当前网络的实际下载 kbps | 1.0.0 |
| port | number | 当前请求的端口 | 1.0.0 |
| socketReused | boolean | 是否复用连接 | 1.0.0 |
| sentBytesCount | number | 发送的字节数 | 1.0.0 |
| receivedBytesCount | number | 收到的字节数 | 1.0.0 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "uploadFile:fail" + 详细错误信息 | 1.0.0 |
返回值
| 类型 | 说明 | 最低支持版本 |
|---|---|---|
| object | 1.0.0 |
错误码
| errorCode | errMsg | errorType | 说明 | 最低支持版本 |
|---|---|---|---|---|
| 121999 | url use invalid protocol, url == %s, url support protocol is %s | D | url协议无效 | 1.0.0 |
| 121999 | url is invalid, url == %s | D | url不合法 | 1.0.0 |
| 121901 | url not in domain list, url == %s | D | url域名不在upload域名列表中 | 1.0.0 |
| 121902 | no file exist, filePath == %s | D | 文件不存在 | 1.0.0 |
| 121985 | network unavailable | U | 用户无网 | 1.0.0 |
| 121985 | network unavailable | U | 用户无网或抖音没有网络权限 | 1.0.0 |
| 121923 | network changed | U | 用户网络波动 | 1.0.0 |
| 121924 | dns error | U | 用户网络波动 | 1.0.0 |
| 121925 | ssl error | U | 用户网络波动 | 1.0.0 |
| 121926 | connection error | U | 用户网络波动 | 1.0.0 |
| 121927 | interrupted | U | 用户网络波动 | 1.0.0 |
| 121928 | certificate error | D | url证书错误 | 1.0.0 |
| 121929 | url error | D | url无效 | 1.0.0 |
| 121991 | network error:%s | F | 1.0.0 | |
| 121920 | request time out | D | 请求超时 | 1.0.0 |
| 121905 | upload file abort | D | 主动中断请求 | 1.0.0 |
| 121906 | file path permission denied, open '%s' | D | 文件路径没有读权限 | 1.0.0 |
| 121992 | %s | F | 1.0.0 | |
| 121994 | app in background | U | 小程序已进入后台 | 1.0.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
