全部產品
Search
文件中心

Object Storage Service:標量檢索(Go SDK V2)

更新時間:Aug 02, 2025

標量檢索是OSS提供的基於Object中繼資料的索引功能,允許您自訂條件,快速篩選並擷取Object列表。本文介紹如何使用Go SDK V2進行標量檢索。

注意事項

  • 本文範例程式碼以華東1(杭州)的地區IDcn-hangzhou為例,預設使用外網Endpoint,如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS地區和訪問網域名稱

  • 本文以從環境變數讀取存取憑證為例。如何配置訪問憑證,請參見配置訪問憑證

範例程式碼

開啟中繼資料管理功能

以下代碼用於為指定Bucket開啟中繼資料管理功能。開啟後,OSS會為Bucket建立中繼資料索引庫並為Bucket中的所有Object建立中繼資料索引。中繼資料索引庫建立完成後,OSS會繼續對Bucket中新增檔案進行准即時的增量追蹤掃描並為增量檔案建立中繼資料索引。

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 // 定義一個變數來儲存從命令列擷取的地區(Region)資訊
	bucketName string // 定義一個變數來儲存從命令列擷取的儲存空間名稱
)

// init函數在main函數之前執行,用來初始化程式
func init() {
	// 設定命令列參數來指定region
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	// 設定命令列參數來指定bucket名稱
	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) // 列印開啟中繼資料管理的結果
}

擷取中繼資料索引庫資訊

以下代碼用於擷取指定Bucket的中繼資料索引庫資訊。

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 // 定義一個變數來儲存從命令列擷取的地區(Region)資訊
	bucketName string // 定義一個變數來儲存從命令列擷取的儲存空間名稱
)

// init函數在main函數之前執行,用來初始化程式
func init() {
	// 設定命令列參數來指定region
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	// 設定命令列參數來指定bucket名稱
	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用戶端執行個體

	// 構建一個GetMetaQueryStatus請求,用於擷取特定儲存空間的中繼資料索引庫資訊
	request := &oss.GetMetaQueryStatusRequest{
		Bucket: oss.Ptr(bucketName), // 指定要查詢的儲存空間名稱
	}
	result, err := client.GetMetaQueryStatus(context.TODO(), request) // 執行請求以擷取儲存空間的中繼資料索引庫資訊
	if err != nil {
		log.Fatalf("failed to get meta query status %v", err) // 如果有錯誤發生,記錄錯誤資訊並終止程式
	}

	log.Printf("get meta query status result:%#v\n", result)
}

查詢滿足指定條件的Object

以下代碼通過標量檢索功能查詢滿足指定條件Object,並按照指定欄位和排序方式列出Object資訊。

package main

import (
	"context"
	"flag"
	"fmt"
	"log"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

var (
	region     string // 定義一個變數來儲存從命令列擷取的地區(Region)資訊
	bucketName string // 定義一個變數來儲存從命令列擷取的儲存空間名稱
)

// init函數在main函數之前執行,用來初始化程式
func init() {
	// 設定命令列參數來指定region,預設為空白字串
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	// 設定命令列參數來指定bucket名稱,預設為空白字串
	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用戶端執行個體

	// 構建一個DoMetaQuery請求,用於執行中繼資料查詢滿足指定條件Object
	request := &oss.DoMetaQueryRequest{
		Bucket: oss.Ptr(bucketName), // 指定要查詢的儲存空間名稱
		MetaQuery: &oss.MetaQuery{
			Query: oss.Ptr(`{"Field": "Size","Value": "1048576","Operation": "gt"}`), // 查詢條件:大小大於1MB的對象
			Sort:  oss.Ptr("Size"),                                                   // 排序欄位:按對象大小排序
			Order: oss.Ptr(oss.MetaQueryOrderAsc),                                    // 排序次序:升序
		},
	}
	result, err := client.DoMetaQuery(context.TODO(), request) // 發送請求以執行中繼資料查詢
	if err != nil {
		log.Fatalf("failed to do meta query %v", err)
	}

	// 列印NextToken,用於分頁查詢下一頁的資料
	fmt.Printf("NextToken:%s\n", *result.NextToken)

	// 遍曆返回的結果,列印出每個檔案的詳細資料
	for _, file := range result.Files {
		fmt.Printf("File name: %s\n", *file.Filename)
		fmt.Printf("size: %d\n", file.Size)
		fmt.Printf("File Modified Time:%s\n", *file.FileModifiedTime)
		fmt.Printf("Oss Object Type:%s\n", *file.OSSObjectType)
		fmt.Printf("Oss Storage Class:%s\n", *file.OSSStorageClass)
		fmt.Printf("Object ACL:%s\n", *file.ObjectACL)
		fmt.Printf("ETag:%s\n", *file.ETag)
		fmt.Printf("Oss CRC64:%s\n", *file.OSSCRC64)
		if file.OSSTaggingCount != nil {
			fmt.Printf("Oss Tagging Count:%d\n", *file.OSSTaggingCount)
		}

		// 列印對象的標籤資訊
		for _, tagging := range file.OSSTagging {
			fmt.Printf("Oss Tagging Key:%s\n", *tagging.Key)
			fmt.Printf("Oss Tagging Value:%s\n", *tagging.Value)
		}

		// 列印使用者自訂中繼資料資訊
		for _, userMeta := range file.OSSUserMeta {
			fmt.Printf("Oss User Meta Key:%s\n", *userMeta.Key)
			fmt.Printf("Oss User Meta Key Value:%s\n", *userMeta.Value)
		}
	}
}

關閉中繼資料管理功能

以下代碼用於關閉指定Bucket的中繼資料管理功能。

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 // 定義一個變數來儲存從命令列擷取的地區(Region)資訊
	bucketName string // 定義一個變數來儲存從命令列擷取的儲存空間名稱
)

// init函數在main函數之前執行,用來初始化程式
func init() {
	// 設定命令列參數來指定region
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	// 設定命令列參數來指定bucket名稱
	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用戶端執行個體

	// 構建一個CloseMetaQuery請求,用於關閉特定儲存空間的中繼資料管理功能
	request := &oss.CloseMetaQueryRequest{
		Bucket: oss.Ptr(bucketName), // 指定要操作的儲存空間名稱
	}
	result, err := client.CloseMetaQuery(context.TODO(), request) // 執行請求以關閉儲存空間的中繼資料管理功能
	if err != nil {
		log.Fatalf("failed to close meta query %v", err) // 如果有錯誤發生,記錄錯誤資訊並終止程式
	}

	log.Printf("close meta query result:%#v\n", result)
}

相關文檔