# 文件存储

# Storage

# Storage.UploadFileAsync

# 1. 接口描述

接口功能:上传文件到文件管理服务

接口声明:public async Task<UploadFileResponse> UploadFileAsync(string cloudPath, string filePath)

# 2. 输入参数

字段 类型 必填 说明
cloudPath string 云端文件的路径
filePath string 本地文件的路径,需要为能直接访问的路径

注:cloudPath 为文件的绝对路径,包含文件名 foo/bar.jpg、foo/bar/baz.jpg 等,不能包含除[0-9 , a-z , A-Z]、/、!、-、_、.、、*和中文以外的字符,使用 / 字符来实现类似传统文件系统的层级结构。查看详情

# 3. 输出参数

# UploadFileResponse
字段 类型 说明
Code string 状态码,操作成功则不返回
Message string 错误描述
RequestId string 请求序列号,用于错误排查
FileID string 文件唯一 ID,用来访问文件,建议存储起来

# 4. 示例代码

using System.Threading.Tasks;
using System.Collections.Generic;
using CloudBase;

// 匿名登录
CloudBaseApp app = CloudBaseApp.Init("your-env-id", 3000);
AuthState state = await app.Auth.GetAuthStateAsync();
if (state == null) {
  await app.Auth.SignInAnonymouslyAsync();
}

// 上传文件
UploadFileResponse res = await app.Storage.UploadFileAsync("test.png", "your-local-file-path");

# Storage.DeleteFilesAsync

# 1. 接口描述

接口功能:删除云端文件

接口声明:public async Task<DeleteFilesResponse> DeleteFilesAsync(List<string> fileIdList)

# 2. 输入参数

字段 类型 必填 说明
fileIdList List<string> 要删除的文件 Id 组成的数组

# 3. 输出参数

# DeleteFilesResponse
字段 类型 说明
Code string 状态码,操作成功则不返回
Message string 错误描述
RequestId string 请求序列号,用于错误排查
FileList List<DeleteMetadata> 删除结果组成的数组
# DeleteMetadata
字段 类型 说明
Code string 删除结果,成功为 SUCCESS
FileID string 文件 ID

# 4. 示例代码

using System.Threading.Tasks;
using System.Collections.Generic;
using CloudBase;

// 匿名登录
CloudBaseApp app = CloudBaseApp.Init("your-env-id", 3000);
AuthState state = await app.Auth.GetAuthStateAsync();
if (state == null) {
  await app.Auth.SignInAnonymouslyAsync();
}

// 删除文件
List<string> files = new List<string>() {"test.png"};
DeleteFilesResponse res = await app.Storage.DeleteFilesAsync(files);

# Storage.GetFileDownloadUrlAsync

# 1. 接口描述

接口功能:获取文件下载链接,可以自定义实现下载文件的方法。

接口声明:public async Task<GetDownloadUrlResponse> GetFileDownloadUrlAsync(List<string> fileIdList)

# 2. 输入参数

字段 类型 必填 说明
fileList List<string> 要下载的文件 ID 组成的数组

# 3. 输出参数

# GetDownloadUrlResponse
字段 类型 说明
Code string 状态码,操作成功则为 SUCCESS
Message string 错误描述
RequestId string 请求序列号,用于错误排查
FileList List<DownloadMetadata> 存储下载链接的数组
# DownloadMetadata
字段 类型 必填 说明
FileId string 文件 ID
DownloadUrl string 文件访问链接

# 4. 示例代码

using System.Threading.Tasks;
using System.Collections.Generic;
using CloudBase;

// 匿名登录
CloudBaseApp app = CloudBaseApp.Init("your-env-id", 3000);
AuthState state = await app.Auth.GetAuthStateAsync();
if (state == null) {
  await app.Auth.SignInAnonymouslyAsync();
}

// 获取下载链接
List<string> files = new List<string>() {"test.png"};
GetDownloadUrlResponse res = await app.Storage.GetFileDownloadUrlAsync(files);