本文介绍如何使用Swift SDK在开启版本控制的存储空间(Bucket)中下载文件(Object)。
注意事项
本文示例代码以华东1(杭州)的地域ID
cn-hangzhou
为例,默认使用外网Endpoint,如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系,请参见OSS地域和访问域名。
权限说明
阿里云账号默认拥有全部权限。阿里云账号下的RAM用户或RAM角色默认没有任何权限,需要阿里云账号或账号管理员通过RAM Policy或Bucket Policy授予操作权限。
API | Action | 说明 |
GetObject |
| 下载Object。 |
| 下载Object时,如果通过versionId指定了Object的版本,则需要授予此操作的权限。 | |
| 下载Object时,如果Object的元数据包含X-Oss-Server-Side-Encryption: KMS,则需要此操作的权限。 |
说明
对某个Bucket执行GetObject操作时,分以下三种情况:
如果该Bucket中Object的当前版本是删除标记(Delete Marker),则返回404 Not Found。
如果在查询参数中指定Object的versionId,则返回指定的Object版本。当versionId指定为“null”时,则返回versionId为“null”的Object版本。
通过指定versionId的方式来获取删除标记时,则返回405 Method Not Allowed。
示例代码
您可以使用以下代码下载文件。
import AlibabaCloudOSS
import Foundation
@main
struct Main {
static func main() async {
do {
// 填写Bucket所在地域。以华东1(杭州)为例,Region填写为cn-hangzhou。
let region = "cn-hangzhou"
// 填写Bucket名称。
let bucket = "yourBucketName"
// 可选项,指定访问OSS服务的域名。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com
let endpoint: String? = nil
// 填写对象名称(如:my-object.txt)。
let key = "yourKey"
// 填写本地文件路径。
let filePath = "yourFilePath"
// 版本id
let versionId = "versionId"
// 从环境变量中获取访问凭证。运行前请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
let credentialsProvider = EnvironmentCredentialsProvider()
// 配置OSS客户端参数
let config = Configuration.default()
.withRegion(region) // 设置区域
.withCredentialsProvider(credentialsProvider) // 设置凭证
// 设置Endpoint
if let endpoint = endpoint {
config.withEndpoint(endpoint)
}
// 创建OSS客户端实例
let client = Client(config)
// 从OSS下载对象到本地文件
let result = try await client.getObjectToFile(
GetObjectRequest(
bucket: bucket,
key: key,
versionId: versionId
),
URL(fileURLWithPath: filePath)
)
print("result:\n\(result)")
} catch {
// 终止程序并输出错误信息
print("error:\(error)")
}
}
}
相关文档
关于下载文件的API接口说明,请参见GetObject。
该文章对您有帮助吗?