このトピックでは、OSS SDK for Go を使用してオブジェクトが存在するかどうかを判断する方法について説明します。
使用上の注意
このトピックのサンプルコードでは、中国 (杭州) リージョンのリージョン ID
cn-hangzhouを使用します。デフォルトでは、パブリックエンドポイントを使用してバケット内のリソースにアクセスします。同じリージョン内の他の Alibaba Cloud サービスからバケット内のリソースにアクセスする場合は、内部エンドポイントを使用します。OSS がサポートするリージョンとエンドポイントの詳細については、「OSS のリージョンとエンドポイント」をご参照ください。このトピックでは、アクセス資格情報は環境変数から取得されます。アクセス資格情報の設定方法の詳細については、「アクセス資格情報の設定」をご参照ください。
オブジェクトをローカルコンピューターにダウンロードするには、
oss:GetObject権限が必要です。詳細については、「RAM ユーザーへのカスタム権限の付与」をご参照ください。
メソッド定義
func (c *Client) IsObjectExist(ctx context.Context, bucket string, key string, optFns ...func(*IsObjectExistOptions)) (bool, error)リクエストパラメーター
パラメーター | タイプ | 説明 |
ctx | context.Context | リクエストのコンテキスト。このパラメーターを使用して、リクエストの合計時間制限を指定できます。 |
bucket | string | バケットの名前。 |
key | string | オブジェクトの名前。 |
optFns | ...func(*IsObjectExistOptions) | (オプション) API レベルの構成パラメーター。詳細については、「IsObjectExistOptions」をご参照ください。 |
戻り値
戻り値 | タイプ | 説明 |
flag | bool | API 操作の戻り値。このパラメーターは、err が nil の場合にのみ有効です。 |
err | error | リクエストのステータス。リクエストが失敗した場合、err は nil ではありません。 |
サンプルコード
次のコードを使用して、オブジェクトが存在するかどうかを判断できます。
package main
import (
"context"
"flag"
"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)
// オブジェクトが存在するかどうかを確認します。
result, err := client.IsObjectExist(context.TODO(), bucketName, objectName)
if err != nil {
log.Fatalf("failed to check if object exists %v", err)
}
// チェック結果を出力します。
log.Printf("is object exist: %#v\n", result)
}
参照
オブジェクトが存在するかどうかを判断するための完全なサンプルコードについては、「GitHub の例」をご参照ください。
オブジェクトが存在するかどうかを判断するために使用される API 操作の詳細については、「IsObjectExist」をご参照ください。