上传文件
- 接口名称: uploadFile
- 接口功能:上传文件至云开发存储服务。
请求参数
响应参数
字段 | 类型 | 必填 | 说明 |
code | string | 否 | 状态码,操作成功则不返回。 |
message | string | 否 | 错误描述。 |
fileID | fileID | 是 | 文件唯一 ID,用来访问文件,建议存储起来。 |
requestId | string | 否 | 请求序列号,用于错误排查。 |
示例代码
获取文件下载链接
- 接口名称:getTempFileURL
- 接口功能:获取已上传至云开发的文件的访问链接。
请求参数
字段 | 类型 | 必填 | 说明 |
fileList | <Array>.string | 是 | 要下载的文件 ID 组成的数组。 |
fileList
字段 | 类型 | 必填 | 说明 |
fileID | string | 是 | 文件 ID。 |
maxAge | Integer | 是 | 文件链接有效期。 |
响应参数
字段 | 类型 | 必填 | 说明 |
code | string | 否 | 状态码,操作成功则为 SUCCESS。 |
message | string | 否 | 错误描述。 |
fileList | <Array>.object | 否 | 存储下载链接的数组。 |
requestId | string | 否 | 请求序列号,用于错误排查。 |
fileList
字段 | 类型 | 必填 | 说明 |
code | string | 否 | 删除结果,成功为 SUCCESS。 |
fileID | string | 是 | 文件 ID。 |
tempFileURL | string | 是 | 文件访问链接。 |
示例代码
删除文件
接口名称:deleteFile
接口功能:删除已上传至云开发的文件。
请求参数
字段 | 类型 | 必填 | 说明 |
fileList | <Array>.string | 是 | 要删除的文件 ID 组成的数组。 |
响应参数
字段 | 类型 | 必填 | 说明 |
code | string | 否 | 状态码,操作成功则不返回。 |
message | string | 否 | 错误描述 |
fileList | <Array>.object | 否 | 删除结果组成的数组。 |
requestId | string | 否 | 请求序列号,用于错误排查。 |
fileList
字段 | 类型 | 必填 | 说明 |
code | string | 否 | 删除结果,成功为 SUCCESS。 |
fileID | string | 是 | 文件 ID。 |
示例代码
下载文件
- 接口名称:downloadFile
- 接口功能:下载已上传至云开发的文件至本地(默认本地根目录/root)。
请求参数
字段 | 类型 | 必填 | 说明 |
fileID | string | 是 | 要下载的文件的 ID。 |
tempFilePath | string | 否 | 下载的文件要存储的位置。 |
响应参数
字段 | 类型 | 必填 | 说明 |
code | string | 否 | 状态码,操作成功则不返回。 |
message | string | 否 | 错误描述。 |
fileContent | Buffer | 否 | 下载的文件的内容。如果传入 tempFilePath 则不返回该字段。 |
requestId | string | 否 | 请求序列号,用于错误排查。 |
示例代码