すべてのプロダクト
Search
ドキュメントセンター

Object Storage Service:オブジェクトのダウンロード

最終更新日:Dec 09, 2024

既定では、バージョン管理が有効なバケット内のオブジェクトに対してGetObject操作を呼び出すと、オブジェクトの現在のバージョンのみが返されます。

背景情報

GetObject操作を呼び出してバケット内のオブジェクトをダウンロードすると、次のいずれかの結果が得られます。

  • オブジェクトの現在のバージョンが削除マーカーである場合、OSSは404 Not Foundを返します。

  • リクエストでオブジェクトのバージョンIDが指定されている場合、OSSは指定されたバージョンのオブジェクトを返します。 リクエストでバージョンIDがnullに設定されている場合、OSSはバージョンIDがnullのバージョンを返します。

  • リクエストで指定されたバージョンIDが削除マーカーのバージョンIDである場合、OSSは405メソッドが許可されていません。

使用上の注意

  • このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。 OSSと同じリージョンにある他のAlibaba CloudサービスからOSSにアクセスする場合は、内部エンドポイントを使用します。 OSSリージョンとエンドポイントの詳細については、「OSSリージョンとエンドポイント」をご参照ください。

  • このトピックでは、OSSエンドポイントを使用してOSSClientインスタンスを作成します。 カスタムドメイン名またはSTS (Security Token Service) を使用してOSSClientインスタンスを作成する場合は、「初期化」をご参照ください。

  • オブジェクトをダウンロードするには、oss:GetObject権限が必要です。 詳細については、「RAMユーザーへのカスタムポリシーのアタッチ」をご参照ください。

サンプルコード

次のサンプルコードは、オブジェクトをダウンロードする方法の例を示しています。

using System;
using System.IO;
using Aliyun.OSS;

namespace Samples
{
    public class Program
    {
        public static void Main(string[] args)
        {
            // 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. 
            var endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
            // 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. 
            var accessKeyId = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_ID");
            var accessKeySecret = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET");
            // Specify the name of the bucket. Example: examplebucket. 
            var bucketName = "examplebucket";
            // Specify the full path of the object. Do not include the bucket name in the full path. Example: exampledir/exampleobject.txt. 
            var objectName = "exampledir/exampleobject.txt";
            // Specify the full path of the local file that you want to upload. Example: D:\\localpath\\examplefile.txt. 
            var downloadFilename = "D:\\localpath\\examplefile.txt";
            var versionid = "yourArchiveObjectVersionid";
            // Specify the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the region to cn-hangzhou.
            const string region = "cn-hangzhou";
            
            // Create a ClientConfiguration instance and modify parameters as required.
            var conf = new ClientConfiguration();
            
            // Use the signature algorithm V4.
            conf.SignatureVersion = SignatureVersion.V4;
            
            // Create an OSSClient instance.
            var client = new OssClient(endpoint, accessKeyId, accessKeySecret, conf);
            c.SetRegion(region);
            try
            {
                // Download the object to a stream. OssObject includes object information, such as the bucket in which the object is stored, the object name, object metadata, and an input stream. 
                var request = new GetObjectRequest(bucketName, objectName)
                {
                    // Specify the version ID of the object. 
                    VersionId = versionid
                };
                var obj = client.GetObject(request);
                using (var requestStream = obj.Content)
                {
                    byte[] buf = new byte[1024];
                    var fs = File.Open(downloadFilename, FileMode.OpenOrCreate);
                    var len = 0;
                    // The input stream can be used to read and download the object content to a local file or to the memory. 
                    while ((len = requestStream.Read(buf, 0, 1024)) != 0)
                    {
                        fs.Write(buf, 0, len);
                    }
                    fs.Close();
                }
                Console.WriteLine("Get object succeeded, vesionid:{0}", versionid);
            }
            catch (Exception ex)
            {
                Console.WriteLine("Get object failed. {0}", ex.Message);
            }
        }
    }
}

関連ドキュメント

オブジェクトをダウンロードするために呼び出すことができるAPI操作の詳細については、「GetObject」をご参照ください。