本文介绍如何通过简单下载方法将存储空间(Bucket)中的文件(Object)下载到本地,此方法操作简便,适合快速将云端存储的文件下载到本地。
注意事项
本文示例代码以华东1(杭州)的地域IDcn-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,则需要此操作的权限。 | 
方法定义
get_object(request: GetObjectRequest, **kwargs) → GetObjectResult请求参数列表
| 参数名 | 类型 | 说明 | 
| request | GetObjectRequest | 设置请求参数,具体请参见GetObjectRequest | 
返回值列表
| 类型 | 说明 | 
| GetObjectResult | 返回值,具体请参见GetObjectResult | 
关于简单下载方法的完整定义,请参见get_object。
示例代码
您可以使用以下代码将存储空间中的文件下载到本地。
import argparse
import alibabacloud_oss_v2 as oss
import os
# 创建命令行参数解析器
parser = argparse.ArgumentParser(description="get object sample")
# 添加命令行参数 --region,表示存储空间所在的区域,必需参数
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
# 添加命令行参数 --bucket,表示存储空间的名称,必需参数
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
# 添加命令行参数 --endpoint,表示其他服务可用来访问OSS的域名,非必需参数
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
# 添加命令行参数 --key,表示对象的名称,必需参数
parser.add_argument('--key', help='The name of the object.', required=True)
def main():
    # 解析命令行参数
    args = parser.parse_args()
    # 从环境变量中加载凭证信息,用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()
    # 加载SDK的默认配置,并设置凭证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    # 设置配置中的区域信息
    cfg.region = args.region
    # 如果提供了endpoint参数,则设置配置中的endpoint
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint
    # 使用配置好的信息创建OSS客户端
    client = oss.Client(cfg)
    # 执行获取对象的请求,指定存储空间名称和对象名称
    result = client.get_object(oss.GetObjectRequest(
        bucket=args.bucket,  # 指定存储空间名称
        key=args.key,  # 指定对象键名
    ))
    # 输出获取对象的结果信息,用于检查请求是否成功
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' content length: {result.content_length},'
          f' content range: {result.content_range},'
          f' content type: {result.content_type},'
          f' etag: {result.etag},'
          f' last modified: {result.last_modified},'
          f' content md5: {result.content_md5},'
          f' cache control: {result.cache_control},'
          f' content disposition: {result.content_disposition},'
          f' content encoding: {result.content_encoding},'
          f' expires: {result.expires},'
          f' hash crc64: {result.hash_crc64},'
          f' storage class: {result.storage_class},'
          f' object type: {result.object_type},'
          f' version id: {result.version_id},'
          f' tagging count: {result.tagging_count},'
          f' server side encryption: {result.server_side_encryption},'
          f' server side data encryption: {result.server_side_data_encryption},'
          f' next append position: {result.next_append_position},'
          f' expiration: {result.expiration},'
          f' restore: {result.restore},'
          f' process status: {result.process_status},'
          f' delete marker: {result.delete_marker},'
    )
    # ========== 方式1:完整读取 ==========
    with result.body as body_stream:
        data = body_stream.read()
        print(f"文件读取完成,数据长度:{len(data)} bytes")
        path = "./get-object-sample.txt"
        with open(path, 'wb') as f:
            f.write(data)
        print(f"文件下载完成,保存至路径:{path}")
    # # ========== 方式2:分块读取 ==========
    # with result.body as body_stream:
    #     chunk_path = "./get-object-sample-chunks.txt"
    #     total_size = 0
    #     with open(chunk_path, 'wb') as f:
    #         # 使用256KB块大小(可根据需要调整block_size参数)
    #         for chunk in body_stream.iter_bytes(block_size=256 * 1024):
    #             f.write(chunk)
    #             total_size += len(chunk)
    #             print(f"已接收数据块:{len(chunk)} bytes | 累计:{total_size} bytes")
    #     print(f"文件下载完成,保存至路径:{chunk_path}")
# 当此脚本被直接运行时,调用main函数
if __name__ == "__main__":
    main()  # 脚本入口,当文件被直接运行时调用main函数常见使用场景
相关文档
- 关于简单下载文件的完整示例代码,请参见get_object.py和get_object_to_file.py。 
该文章对您有帮助吗?