Download objects - Object Storage Service - Alibaba Cloud Documentation Center

By default, when you call the GetObject operation on an object in a versioning-enabled bucket, only the current version of the object is returned.

Background information

When you call the GetObject operation to download an object in a bucket, you may obtain one of the following results:

If the current version of the object is a delete marker, OSS returns 404 Not Found.
If a version ID of the object is specified in the request, OSS returns the specified version of the object. If the version ID is set to null in the request, OSS returns the version whose version ID is null.
If the version ID specified in the request is the version ID of a delete marker, OSS returns 405 Method Not Allowed.

Usage notes

In this topic, the public endpoint of the China (Hangzhou) region is used. If you want to access OSS from other Alibaba Cloud services in the same region as OSS, use an internal endpoint. For more information about OSS regions and endpoints, see Regions, endpoints and open ports.
In this topic, access credentials are obtained from environment variables. For more information about how to configure access credentials, see Configure access credentials.
In this topic, an OSSClient instance is created by using an OSS endpoint. If you want to create an OSSClient instance by using custom domain names or Security Token Service (STS), see Initialization.
To download an object, you must have the oss:GetObject permission. For more information, see Attach a custom policy to a RAM user.

Sample code

The following sample code provides an example on how to download an object:

# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. 
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# Specify the ID of the region that maps to the endpoint. Example: cn-hangzhou. This parameter is required if you use the signature algorithm V4.
region = "cn-hangzhou"

# Specify the name of your bucket.
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)

# Download a specific version of the object. 
params = dict()
params['versionId'] = '<yourObjectVersionId>'
object_stream = bucket.get_object('<yourObjectName>', params=params)

# Read the content of the downloaded object. 
read_content = object_stream.read()
print('get object content:', read_content)
# Display the version ID of the downloaded object. 
print('get object versionid:', object_stream.versionid)

# You must call read() to read the object from the stream that is returned by get_object before you can calculate the CRC-64 checksum of the object. 
if object_stream.client_crc != object_stream.server_crc:
   print("The CRC checksum between client and server is inconsistent!")

References

For more information about the API operation that you can call to download an object, see GetObject.