Object Storage Service:スカラー検索を使用してメタデータプロパティに基づいて OSS 内のファイルをクエリする

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.MetaQueryMode;

public class OpenMetaQuery {
    public static void main(String[] args) throws com.aliyuncs.exceptions.ClientException {
        // この例では、中国 (杭州) リージョンのエンドポイントが使用されます。
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // バケットの名前を指定します。例: examplebucket。
        String bucketName = "examplebucket";
        // 環境変数からアクセス資格情報を取得します。
        // サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // バケットが配置されているリージョンを指定します。たとえば、バケットが中国 (杭州) リージョンにある場合、リージョンを cn-hangzhou に設定します。
        String region = "cn-hangzhou";

        // OSSClient インスタンスを作成します。
        //OSSClient インスタンスが不要になったら、shutdown メソッドを呼び出して関連リソースを解放します。
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
        OSS ossClient = OSSClientBuilder.create()
                .endpoint(endpoint)
                .credentialsProvider(credentialsProvider)
                .clientConfiguration(clientBuilderConfiguration)
                .region(region)
                .build();

        try {
            // MetaSearch 機能を有効にします。
            ossClient.openMetaQuery(bucketName);
        } catch (OSSException oe) {
            System.out.println("Error Message:" + oe.getErrorMessage());
            System.out.println("Error Code:" + oe.getErrorCode());
            System.out.println("Request ID:" + oe.getRequestId());
            System.out.println("Host ID:" + oe.getHostId());
        } catch (ClientException ce) {
            System.out.println("Error Message: " + ce.getMessage());
        } finally {
            // OSSClient インスタンスをシャットダウンします。
            if(ossClient != null){
                ossClient.shutdown();
            }
        }
    }
}

import argparse
import alibabacloud_oss_v2 as oss

# コマンドラインパラメーターパーサーを作成し、説明を追加します。
parser = argparse.ArgumentParser(description="open meta query 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')

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
    # エンドポイントが提供されている場合、構成内のエンドポイントを更新します。
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # OSS クライアントを作成します。
    client = oss.Client(cfg)

    # メタクエリを有効にするリクエストを開始します。
    result = client.open_meta_query(oss.OpenMetaQueryRequest(
            bucket=args.bucket,
    ))

    # リクエストのステータスコードとリクエスト ID を出力します。
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          )

# メインプログラムとして実行された場合、main 関数を呼び出します。
if __name__ == "__main__":
    main()

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 // コマンドラインから取得したバケット名を格納する変数を定義します。
)

// init 関数は、プログラムを初期化するために main 関数の前に実行されます。
func init() {
	// リージョンを指定するためのコマンドラインパラメーターを設定します。
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	// バケット名を指定するためのコマンドラインパラメーターを設定します。
	flag.StringVar(&bucketName, "bucket", "", "The name of the bucket.")
}

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") // エラーをログに記録し、プログラムを終了します。
	}

	// クライアント構成を作成し、資格情報プロバイダーとして環境変数を使用します。
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion(region)

	client := oss.NewClient(cfg) // 構成を使用して OSS クライアントインスタンスを作成します。

	// 特定のバケットのメタデータ管理機能を有効にするために OpenMetaQuery リクエストを作成します。
	request := &oss.OpenMetaQueryRequest{
		Bucket: oss.Ptr(bucketName), // 操作対象のバケットの名前を指定します。
	}
	result, err := client.OpenMetaQuery(context.TODO(), request) // バケットのメタデータ管理機能を有効にするリクエストを実行します。
	if err != nil {
		log.Fatalf("failed to open meta query %v", err) // エラーが発生した場合、エラーメッセージをログに記録し、プログラムを終了します。
	}

	log.Printf("open meta query result:%#v\n", result) // メタデータ管理を有効にした結果を出力します。
}

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.*;
import java.util.ArrayList;
import java.util.List;

public class DoMetaQuery {
    public static void main(String[] args) throws Exception {
        // この例では、中国 (杭州) リージョンのエンドポイントが使用されます。
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // バケットの名前を指定します。例: examplebucket。
        String bucketName = "examplebucket";
        // 環境変数からアクセス資格情報を取得します。
        // サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // バケットが配置されているリージョンを指定します。たとえば、バケットが中国 (杭州) リージョンにある場合、リージョンを cn-hangzhou に設定します。
        String region = "cn-hangzhou";

        // OSSClient インスタンスを作成します。
        // OSSClient インスタンスが不要になったら、shutdown メソッドを呼び出して関連リソースを解放します。
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
        OSS ossClient = OSSClientBuilder.create()
                .endpoint(endpoint)
                .credentialsProvider(credentialsProvider)
                .clientConfiguration(clientBuilderConfiguration)
                .region(region)
                .build();

        try {
            // 特定の条件を満たすオブジェクトをクエリし、特定のフィールドに基づいて指定された順序でオブジェクトを返します。
            int maxResults = 20;
            // サイズが 1,048,576 バイト未満のオブジェクトをクエリし、一度に最大 20 個のオブジェクトを返し、オブジェクトを昇順にソートします。
            String query = "{\"Field\": \"Size\",\"Value\": \"1048576\",\"Operation\": \"lt\"}";
            String sort = "Size";
            DoMetaQueryRequest doMetaQueryRequest = new DoMetaQueryRequest(bucketName, maxResults, query, sort);
            Aggregation aggregationRequest = new Aggregation();
            Aggregations aggregations = new Aggregations();
            List<Aggregation> aggregationList = new ArrayList<Aggregation>();
            // 集約操作で使用されるフィールドの名前を指定します。
            aggregationRequest.setField("Size");
            // 集約操作で使用される演算子を指定します。max は最大値を示します。
            aggregationRequest.setOperation("max");
            aggregationList.add(aggregationRequest);
            aggregations.setAggregation(aggregationList);

            // 集約操作を指定します。
            doMetaQueryRequest.setAggregations(aggregations);
            doMetaQueryRequest.setOrder(SortOrder.ASC);
            DoMetaQueryResult doMetaQueryResult = ossClient.doMetaQuery(doMetaQueryRequest);
            if(doMetaQueryResult.getFiles() != null){
                for(ObjectFile file : doMetaQueryResult.getFiles().getFile()){
                    System.out.println("Filename: " + file.getFilename());
                    // オブジェクトのコンテンツを識別するために使用される ETag 値をクエリします。
                    System.out.println("ETag: " + file.getETag());
                    // オブジェクトのアクセス制御リスト (ACL) をクエリします。
                    System.out.println("ObjectACL: " + file.getObjectACL());
                    // オブジェクトのタイプをクエリします。
                    System.out.println("OssObjectType: " + file.getOssObjectType());
                    // オブジェクトのストレージクラスをクエリします。
                    System.out.println("OssStorageClass: " + file.getOssStorageClass());
                    // オブジェクトのタグ数をクエリします。
                    System.out.println("TaggingCount: " + file.getOssTaggingCount());
                    if(file.getOssTagging() != null){
                        for(Tagging tag : file.getOssTagging().getTagging()){
                            System.out.println("Key: " + tag.getKey());
                            System.out.println("Value: " + tag.getValue());
                        }
                    }
                    if(file.getOssUserMeta() != null){
                        for(UserMeta meta : file.getOssUserMeta().getUserMeta()){
                            System.out.println("Key: " + meta.getKey());
                            System.out.println("Value: " + meta.getValue());
                        }
                    }
                }
            } else if(doMetaQueryResult.getAggregations() != null){
                for(Aggregation aggre : doMetaQueryResult.getAggregations().getAggregation()){
                    // 集約が実行されるフィールドをクエリします。
                    System.out.println("Field: " + aggre.getField());
                    // 集約演算子をクエリします。
                    System.out.println("Operation: " + aggre.getOperation());
                    // 集約操作の結果をクエリします。
                    System.out.println("Value: " + aggre.getValue());
                    if(aggre.getGroups() != null && aggre.getGroups().getGroup().size() > 0){
                        // 集約の値をクエリします。
                        System.out.println("Groups value: " + aggre.getGroups().getGroup().get(0).getValue());
                        // 集約の合計数をクエリします。
                        System.out.println("Groups count: " + aggre.getGroups().getGroup().get(0).getCount());
                    }
                }
            } else {
                System.out.println("NextToken: " + doMetaQueryResult.getNextToken());
            }
        } catch (OSSException oe) {
            System.out.println("Error Message:" + oe.getErrorMessage());
            System.out.println("Error Code:" + oe.getErrorCode());
            System.out.println("Request ID:" + oe.getRequestId());
            System.out.println("Host ID:" + oe.getHostId());
        } catch (ClientException ce) {
            System.out.println("Error Message: " + ce.getMessage());
        } finally {
            // OSSClient インスタンスをシャットダウンします。
            ossClient.shutdown();
        }
    }
}

import argparse
import alibabacloud_oss_v2 as oss

# ユーザー入力パラメーターを受け入れるためのコマンドラインパラメーターパーサーを作成します。
parser = argparse.ArgumentParser(description="do meta query sample")
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

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
    # エンドポイントが提供されている場合、構成内のエンドポイントを更新します。
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # OSS クライアントを作成します。
    client = oss.Client(cfg)

    # メタクエリ操作を実行します。
    result = client.do_meta_query(oss.DoMetaQueryRequest(
            bucket=args.bucket,  # クエリするバケットを指定します。
            meta_query=oss.MetaQuery(  # クエリの具体的な内容を定義します。
                aggregations=oss.MetaQueryAggregations(  # 集約操作を定義します。
                    aggregations=[  # 集約リスト。
                        oss.MetaQueryAggregation(  # 最初の集約: 合計サイズを計算します。
                            field='Size',
                            operation='sum',
                        ),
                        oss.MetaQueryAggregation(  # 2 番目の集約: 最大値を見つけます。
                            field='Size',
                            operation='max',
                        )
                    ],
                ),
                next_token='',  # ページネーショントークン。
                max_results=80369,  # 返す結果の最大数。
                query='{"Field": "Size","Value": "1048576","Operation": "gt"}',  # クエリ条件。
                sort='Size',  # ソートフィールド。
                order=oss.MetaQueryOrderType.DESC,  # ソート順。
            ),
    ))

    # クエリ結果の基本情報を出力します。
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          # 以下のコメントアウトされたセクションは、必要に応じて有効にして、より詳細な情報を取得できます。
          # f' files: {result.files},'
          # f' file: {result.files.file},'
          # f' file modified time: {result.files.file.file_modified_time},'
          # f' etag: {result.files.file.etag},'
          # f' server side encryption: {result.files.file.server_side_encryption},'
          # f' oss tagging count: {result.files.file.oss_tagging_count},'
          # f' oss tagging: {result.files.file.oss_tagging},'
          # f' key: {result.files.file.oss_tagging.taggings[0].key},'
          # f' value: {result.files.file.oss_tagging.taggings[0].value},'
          # f' key: {result.files.file.oss_tagging.taggings[1].key},'
          # f' value: {result.files.file.oss_tagging.taggings[1].value},'
          # f' oss user meta: {result.files.file.oss_user_meta},'
          # f' key: {result.files.file.oss_user_meta.user_metas[0].key},'
          # f' value: {result.files.file.oss_user_meta.user_metas[0].value},'
          # f' key: {result.files.file.oss_user_meta.user_metas[1].key},'
          # f' value: {result.files.file.oss_user_meta.user_metas[1].value},'
          # f' filename: {result.files.file.filename},'
          # f' size: {result.files.file.size},'
          # f' oss object type: {result.files.file.oss_object_type},'
          # f' oss storage class: {result.files.file.oss_storage_class},'
          # f' object acl: {result.files.file.object_acl},'
          # f' oss crc64: {result.files.file.oss_crc64},'
          # f' server side encryption customer algorithm: {result.files.file.server_side_encryption_customer_algorithm},'
          # f' aggregations: {result.aggregations},'
          f' field: {result.aggregations.aggregations[0].field},'
          f' operation: {result.aggregations.aggregations[0].operation},'
          f' field: {result.aggregations.aggregations[1].field},'
          f' operation: {result.aggregations.aggregations[1].operation},'
          f' next token: {result.next_token},'
    )

    # ファイル情報が存在する場合、タグとユーザー定義メタデータを出力します。
    if result.files:
        if result.files.file.oss_tagging.taggings:
            for r in result.files.file.oss_tagging.taggings:
                print(f'result: key: {r.key}, value: {r.value}')
        if result.files.file.oss_user_meta.user_metas:
            for r in result.files.file.oss_user_meta.user_metas:
                print(f'result: key: {r.key}, value: {r.value}')
    # すべての集約の結果を出力します。
    if result.aggregations.aggregations:
        for r in result.aggregations.aggregations:
            print(f'result: field: {r.field}, operation: {r.operation}')

if __name__ == "__main__":
    main()