cf-storage.md 4.6 KB
Newer Older
雪洛's avatar
雪洛 已提交
1
## uniCloud.uploadFile(Object uploadFileOptions)
雪洛's avatar
雪洛 已提交
2

雪洛's avatar
雪洛 已提交
3
上传文件至云开发存储服务。**目前仅腾讯云支持此接口**
雪洛's avatar
雪洛 已提交
4

雪洛's avatar
雪洛 已提交
5
**uploadFileOptions参数说明**
雪洛's avatar
雪洛 已提交
6

雪洛's avatar
雪洛 已提交
7 8 9 10
| 字段				| 类型					| 必填| 说明																																															|
| ---					| ---						| ---	| ---																																																|
| cloudPath		| string				| 是	| 文件的绝对路径,包含文件名。例如 foo/bar.jpg、foo/bar/baz.jpg 等。																|
| fileContent	| fs.ReadStream	| 是	| buffer或要上传的文件 [可读流](https://nodejs.org/api/stream.html#stream_class_stream_readable) 。	|
雪洛's avatar
雪洛 已提交
11

雪洛's avatar
雪洛 已提交
12 13 14 15 16 17 18 19
**响应参数**

| 字段			| 类型	| 必填| 说明																			|
| ---				| ---		| ---	| ---																				|
| code			| string| 否	| 状态码,操作成功则不返回。								|
| message		| string| 否	| 错误描述。																|
| fileID		| fileID| 是	| 文件唯一 ID,用来访问文件,建议存储起来。	|
| requestId	| string| 否	| 请求序列号,用于错误排查。								|
雪洛's avatar
雪洛 已提交
20

雪洛's avatar
雪洛 已提交
21
**示例代码**
雪洛's avatar
雪洛 已提交
22 23 24 25 26 27 28 29 30 31

```javascript
const fs = require("fs");

let result = await uniCloud.uploadFile({
    cloudPath: "test-admin.jpeg",
    fileContent: fs.createReadStream(`${__dirname}/cos.jpeg`)
});
```

雪洛's avatar
雪洛 已提交
32
## uniCloud.getTempFileURL(Object getTempFileURLOptions)
雪洛's avatar
雪洛 已提交
33

雪洛's avatar
雪洛 已提交
34
获取文件下载链接,**目前仅腾讯云支持**
雪洛's avatar
雪洛 已提交
35

雪洛's avatar
雪洛 已提交
36
**getTempFileURLOptions参数说明**
雪洛's avatar
雪洛 已提交
37

雪洛's avatar
雪洛 已提交
38 39 40
| 字段		| 类型								| 必填| 说明												|
| ---			| ---									| ---	| ---													|
| fileList| <Array>.string| 是	| 要下载的文件 ID 组成的数组。|
雪洛's avatar
雪洛 已提交
41

雪洛's avatar
雪洛 已提交
42
**fileList字段**
雪洛's avatar
雪洛 已提交
43

雪洛's avatar
雪洛 已提交
44 45 46 47
| 字段	| 类型		| 必填| 说明						|
| ---		| ---			| ---	| ---							|
| fileID| string	| 是	| 文件 ID。				|
| maxAge| Integer	| 是	| 文件链接有效期。|
雪洛's avatar
雪洛 已提交
48

雪洛's avatar
雪洛 已提交
49
**响应参数**
雪洛's avatar
雪洛 已提交
50

雪洛's avatar
雪洛 已提交
51 52 53 54 55 56
| 字段			| 类型								| 必填| 说明													|
| ---				| ---									| ---	| ---														|
| code			| string							| 否	| 状态码,操作成功则为 SUCCESS。|
| message		| string							| 否	| 错误描述。										|
| fileList	| <Array>.object| 否	| 存储下载链接的数组。					|
| requestId	| string							| 否	| 请求序列号,用于错误排查。		|
雪洛's avatar
雪洛 已提交
57

雪洛's avatar
雪洛 已提交
58
**fileList字段**
雪洛's avatar
雪洛 已提交
59

雪洛's avatar
雪洛 已提交
60 61 62 63 64 65 66
| 字段				| 类型	| 必填| 说明											|
| ---					| ---		| ---	| ---												|
| code				| string| 否	| 删除结果,成功为 SUCCESS。|
| fileID			| string| 是	| 文件 ID。									|
| tempFileURL	| string| 是	| 文件访问链接。						|

**示例代码**
雪洛's avatar
雪洛 已提交
67 68 69 70 71 72 73

```javascript
let result = await uniCloud.getTempFileURL({
    fileList: ['cloud://test-28farb/a.png']
});
```

雪洛's avatar
雪洛 已提交
74
## uniCloud.deleteFile(Object deleteFileOptions)
雪洛's avatar
雪洛 已提交
75

雪洛's avatar
雪洛 已提交
76
删除云端文件。
雪洛's avatar
雪洛 已提交
77

雪洛's avatar
雪洛 已提交
78
**deleteFileOptions参数说明**
雪洛's avatar
雪洛 已提交
79

雪洛's avatar
雪洛 已提交
80 81 82
| 字段		| 类型								| 必填| 说明												|
| ---			| ---									| ---	| ---													|
| fileList| <Array>.string| 是	| 要删除的文件 ID 组成的数组。|
雪洛's avatar
雪洛 已提交
83

雪洛's avatar
雪洛 已提交
84
**响应参数**
雪洛's avatar
雪洛 已提交
85

雪洛's avatar
雪洛 已提交
86 87 88 89 90 91
| 字段			| 类型								| 必填| 说明											|
| ---				| ---									| ---	| ---												|
| code			| string							| 否	| 状态码,操作成功则不返回。|
| message		| string							| 否	| 错误描述									|
| fileList	| <Array>.object| 否	| 删除结果组成的数组。			|
| requestId	| string							| 否	| 请求序列号,用于错误排查。|
雪洛's avatar
雪洛 已提交
92

雪洛's avatar
雪洛 已提交
93
**fileList字段**
雪洛's avatar
雪洛 已提交
94 95 96 97 98 99

| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| code | string | 否 | 删除结果,成功为SUCCESS。 |
| fileID | string | 是 | 文件 ID。 |

雪洛's avatar
雪洛 已提交
100
**示例代码**
雪洛's avatar
雪洛 已提交
101 102 103 104 105 106 107 108 109

```javascript
let result = await uniCloud.deleteFile({
    fileList: [
        "cloud://test-28farb/a.png"
    ]
});
```

雪洛's avatar
雪洛 已提交
110
## uniCloud.downloadFile(Object downloadFileOptions)
雪洛's avatar
雪洛 已提交
111

雪洛's avatar
雪洛 已提交
112
下载已上传至云开发的文件至本地(默认本地根目录/root)。
雪洛's avatar
雪洛 已提交
113

雪洛's avatar
雪洛 已提交
114
**downloadFileOptions参数说明**
雪洛's avatar
雪洛 已提交
115

雪洛's avatar
雪洛 已提交
116 117 118 119
| 字段				| 类型	| 必填| 说明										|
| ---					| ---		| ---	| ---											|
| fileID			| string| 是	| 要下载的文件的 ID。			|
| tempFilePath| string| 否	| 下载的文件要存储的位置。|
雪洛's avatar
雪洛 已提交
120

雪洛's avatar
雪洛 已提交
121 122 123 124 125 126 127 128
**响应参数**

| 字段				| 类型	| 必填| 说明																										|
| ---					| ---		| ---	| ---																											|
| code				| string| 否	| 状态码,操作成功则不返回。															|
| message			| string| 否	| 错误描述。																							|
| fileContent	| Buffer| 否	| 下载的文件的内容。如果传入 tempFilePath 则不返回该字段。|
| requestId		| string| 否	| 请求序列号,用于错误排查。															|
雪洛's avatar
雪洛 已提交
129

雪洛's avatar
雪洛 已提交
130
**示例代码**
雪洛's avatar
雪洛 已提交
131 132 133 134 135 136 137

```javascript
let result = await uniCloud.downloadFile({
    fileID: "cloud://aa-99j9f/my-photo.png",
    // tempFilePath: '/tmp/test/storage/my-photo.png'
});
```