このトピックでは、範囲のダウンロードを使用して、ファイルから特定の範囲のデータを効率的にダウンロードする方法について説明します。
使用上の注意
このトピックのサンプルコードでは、中国 (杭州) リージョン ID の
cn-hangzhouを使用します。デフォルトでは、パブリックエンドポイントが使用されます。同じリージョン内の他の Alibaba Cloud プロダクトから OSS にアクセスする場合は、内部エンドポイントを使用します。OSS がサポートするリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。このトピックでは、アクセス資格情報は環境変数から読み取られます。アクセス資格情報の設定方法の詳細については、「アクセス資格情報の設定」をご参照ください。
権限
デフォルトでは、Alibaba Cloud アカウントは完全な権限を持っています。Alibaba Cloud アカウント下の RAM ユーザーまたは RAM ロールは、デフォルトでは何の権限も持っていません。Alibaba Cloud アカウントまたはアカウント管理者は、RAM ポリシーまたはバケットポリシーを通じて操作権限を付与する必要があります。
API | アクション | 定義 |
GetObject |
| オブジェクトをダウンロードします。 |
| オブジェクトをダウンロードする際に、versionId を通じてオブジェクトのバージョンを指定する場合、この権限が必要です。 | |
| オブジェクトをダウンロードする際に、オブジェクトのメタデータに X-Oss-Server-Side-Encryption: KMS が含まれている場合、この権限が必要です。 |
メソッドの定義
func (c *Client) GetObject(ctx context.Context, request *GetObjectRequest, optFns ...func(*Options)) (*GetObjectResult, error)リクエストパラメーター
パラメーター | 型 | 説明 |
ctx | context.Context | リクエストのコンテキスト。リクエストの合計タイムアウト期間を設定するために使用できます。 |
request | *GetObjectRequest | 特定の API 操作のリクエストパラメーター。たとえば、Range パラメーターを設定してダウンロード範囲を指定したり、RangeBehavior パラメーターを設定して標準の範囲ダウンロード動作を指定したりできます。詳細については、「GetObjectRequest」をご参照ください。 |
optFns | ...func(*Options) | オプション。操作レベルの構成パラメーター。詳細については、「Options」をご参照ください。 |
戻り値
戻り値 | 型 | 説明 |
result | *GetObjectResult | API 操作の戻り値。このパラメーターは、err が nil の場合に有効です。詳細については、「GetObjectResult」をご参照ください。 |
err | error | リクエストのステータス。リクエストが失敗した場合、err は nil ではありません。 |
1,000 バイトのオブジェクトの場合、有効なダウンロード範囲は 0 バイトから 999 バイトまでです。指定された範囲が無効な場合、Range パラメーターは効果がありません。応答は 200 ステータスコードを返し、オブジェクト全体が転送されます。無効なリクエストとその結果の例を次に示します。
Range: bytes=500-2000 と設定した場合、範囲の終点が無効です。ファイル全体が返され、HTTP ステータスコードは 200 になります。
Range: bytes=1000-2000 と設定した場合、範囲の始点が無効です。ファイル全体が返され、HTTP ステータスコードは 200 になります。
x-oss-range-behavior:standard リクエストヘッダーを追加して、標準の範囲ダウンロード動作を指定できます。これにより、無効な範囲に対する OSS のダウンロード動作が変更されます。1,000 バイトのオブジェクトの場合:
Range: bytes=500-2000 と設定した場合、範囲の終点が無効です。500 バイトから 999 バイトまでのデータが返され、HTTP ステータスコードは 206 になります。
Range: bytes=1000-2000 と設定した場合、範囲の始点が無効です。HTTP 416 ステータスコードと InvalidRange エラーコードが返されます。
サンプルコード
次のサンプルコードは、RangeBehavior:standard リクエストヘッダーを追加して、標準のダウンロード動作を使用してファイルの指定された範囲からデータをダウンロードする方法を示しています。
package main
import (
"context"
"flag"
"io"
"log"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)
// グローバル変数を定義します。
var (
region string // リージョン。
bucketName string // バケット名。
objectName string // オブジェクト名。
)
// init 関数は、コマンドラインパラメーターを初期化するために使用されます。
func init() {
flag.StringVar(®ion, "region", "", "The region in which the bucket is located.")
flag.StringVar(&bucketName, "bucket", "", "The name of the bucket.")
flag.StringVar(&objectName, "object", "", "The name of the object.")
}
func main() {
// コマンドラインパラメーターを解析します。
flag.Parse()
// バケット名が空かどうかを確認します。
if len(bucketName) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, bucket name required")
}
// リージョンが空かどうかを確認します。
if len(region) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, region required")
}
// オブジェクト名が空かどうかを確認します。
if len(objectName) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, object name required")
}
// デフォルトの構成をロードし、資格情報プロバイダーとリージョンを設定します。
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// OSS クライアントを作成します。
client := oss.NewClient(cfg)
// オブジェクトを取得するリクエストを作成します。
request := &oss.GetObjectRequest{
Bucket: oss.Ptr(bucketName), // バケット名。
Key: oss.Ptr(objectName), // オブジェクト名。
Range: oss.Ptr("bytes=15-35"), // ダウンロード範囲を指定します。
RangeBehavior: oss.Ptr("standard"), // 標準の範囲ダウンロード動作を指定します。
}
// オブジェクトを取得する操作を実行し、結果を処理します。
result, err := client.GetObject(context.TODO(), request)
if err != nil {
log.Fatalf("failed to get object %v", err)
}
defer result.Body.Close() // 関数が終了するときにレスポンス本文が閉じられるようにします。
log.Printf("get object result:%#v\n", result)
// オブジェクトのコンテンツを読み取ります。
data, _ := io.ReadAll(result.Body)
log.Printf("body:%s\n", data)
}