本文介紹如何列舉當前帳號所有地區下符合指定條件的儲存空間。
注意事項
本文範例程式碼以華東1（杭州）的地區ID
cn-hangzhou為例，預設使用外網Endpoint，如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS地區和訪問網域名稱。本文以從環境變數讀取存取憑證為例。如何配置訪問憑證，請參見配置訪問憑證。
要列舉儲存空間，您必須具有
oss:ListBuckets許可權。具體操作，請參見為RAM使用者授權自訂的權限原則。
方法定義
進階版列舉儲存空間API
重要
對常用的列舉介面，Go SDK V2最新提供了分頁器（Paginator）支援自動分頁，當進行多次調用時，自動為您擷取下一頁結果。使用分頁器時，您只需要編寫處理結果的代碼。
分頁器包含了分頁器對象<OperationName>Paginator和分頁器建立方法New<OperationName>Paginator。分頁器建立方法返回一個分頁器對象，該對象實現了HasNext和NextPage方法，分別用於判斷是否還有更多頁，並叫用作業來擷取下一頁。
列舉儲存空間的介面定義如下：
type ListBucketsPaginator struct
func (c *Client) NewListBucketsPaginator(request *ListBucketsRequest, optFns ...func(*PaginatorOptions)) *ListBucketsPaginator
func (p *ListBucketsPaginator) HasNext() bool
func (p *ListBucketsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*<OperationName>Result, error)請求參數列表
參數名 | 類型 | 說明 |
request | *ListBucketsRequest | 設定介面的請求參數，具體請參見ListBucketsRequest |
optFns | ...func(*PaginatorOptions) | （可選）介面級的配置參數, 請參見PaginatorOptions |
傳回值列表
傳回值 | 說明 |
*ListBucketsPaginator | 分頁器對象，該對象實現了HasNext和NextPage方法，分別用於判斷是否還有更多頁, 並叫用作業來擷取下一頁 |
基礎版列舉儲存空間API
func (c *Client) ListBuckets(ctx context.Context, request *ListBucketsRequest, optFns ...func(*Options)) (*ListBucketsResult, error)請求參數列表
參數名 | 類型 | 說明 |
ctx | context.Context | 請求的上下文，可以用來佈建要求的總時限 |
request | *ListBucketsRequest | 設定具體介面的請求參數，具體請參見ListBucketsRequest |
optFns | ...func(*Options) | （可選）介面級的配置參數, 具體請參見Options |
傳回值列表
傳回值名 | 類型 | 說明 |
result | *ListBucketsResult | 介面傳回值，當 err 為nil 時有效，具體請參見ListBucketsResult |
err | error | 請求的狀態，當請求失敗時，err 不為 nil |
範例程式碼
使用進階版API列舉儲存空間
您可以使用以下代碼列舉當前帳號所有地區下的儲存空間。
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 // 儲存地區
)
// init函數用於初始化命令列參數
func init() {
flag.StringVar(®ion, "region", "", "The region in which the bucket is located.")
}
func main() {
// 解析命令列參數
flag.Parse()
// 檢查region是否為空白
if len(region) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, region required")
}
// 載入預設配置並設定憑證提供者和地區
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// 建立OSS用戶端
client := oss.NewClient(cfg)
// 建立列出儲存空間的請求
request := &oss.ListBucketsRequest{}
// 定義一個函數來處理 PaginatorOptions
modifyOptions := func(opts *oss.PaginatorOptions) {
// 在這裡可以修改opts的值，比如設定每頁返回的儲存空間數量上限
// 樣本：opts.Limit = 5，即每頁返回5個儲存空間
opts.Limit = 5
}
// 建立分頁器
p := client.NewListBucketsPaginator(request, modifyOptions)
var i int
log.Println("Buckets:")
// 遍曆分頁器中的每一頁
for p.HasNext() {
i++
// 擷取下一頁的資料
page, err := p.NextPage(context.TODO())
if err != nil {
log.Fatalf("failed to get page %v, %v", i, err)
}
// 列印該頁中的每個儲存空間的資訊
for _, b := range page.Buckets {
log.Printf("Bucket: %v, StorageClass: %v, Location: %v\n", oss.ToString(b.Name), oss.ToString(b.StorageClass), oss.ToString(b.Location))
}
}
}
使用基礎版API列舉儲存空間
您可以使用以下代碼列舉當前帳號所有地區下的儲存空間。
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 // 儲存地區
)
// init 函數用於初始化命令列參數
func init() {
flag.StringVar(®ion, "region", "", "The region in which the bucket is located.")
}
func main() {
// 解析命令列參數
flag.Parse()
// 檢查region是否為空白
if len(region) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, region required")
}
// 載入預設配置並設定憑證提供者和地區
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// 建立 OSS 用戶端
client := oss.NewClient(cfg)
var marker string = ""
// 建立 ListBucketsRequest 請求
request := &oss.ListBucketsRequest{
Prefix: oss.Ptr(""),
MaxKeys: 10,
Marker: &marker,
}
// 列舉當前帳號所有地區下的儲存空間
for {
lsRes, err := client.ListBuckets(context.TODO(), request)
if err != nil {
log.Fatalf("Failed to list buckets: %v", err)
}
for _, bucket := range lsRes.Buckets {
log.Printf("Bucket: %s", *bucket.Name)
}
if !lsRes.IsTruncated {
break
}
marker = *lsRes.NextMarker
}
log.Println("List buckets successfully!")
}
常見使用情境
列舉指定首碼的儲存空間
使用分頁器Paginator
您可以使用以下代碼列舉當前帳號所有地區下，以example為首碼（prefix）的儲存空間。
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 // 儲存地區
)
// init函數用於初始化命令列參數
func init() {
flag.StringVar(®ion, "region", "", "The region in which the bucket is located.")
}
func main() {
// 解析命令列參數
flag.Parse()
// 檢查region是否為空白
if len(region) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, region required")
}
// 載入預設配置並設定憑證提供者和地區
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// 建立OSS用戶端
client := oss.NewClient(cfg)
// 建立列出儲存空間的請求
request := &oss.ListBucketsRequest{
Prefix: oss.Ptr("example"), // 設定首碼為"example"，只列出名稱以該prefix開頭的儲存空間
}
// 建立分頁器
p := client.NewListBucketsPaginator(request)
var i int
log.Println("Buckets:")
// 遍曆分頁器中的每一頁
for p.HasNext() {
i++
// 擷取下一頁的資料
page, err := p.NextPage(context.TODO())
if err != nil {
log.Fatalf("failed to get page %v, %v", i, err)
}
// 列印該頁中的每個儲存空間的資訊
for _, b := range page.Buckets {
log.Printf("Bucket: %v, StorageClass: %v, Location: %v\n", oss.ToString(b.Name), oss.ToString(b.StorageClass), oss.ToString(b.Location))
}
}
}
使用ListBuckets
您可以使用以下代碼列舉當前帳號所有地區下，以example為首碼（prefix）的儲存空間。
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 // 儲存地區
)
// init 函數用於初始化命令列參數
func init() {
flag.StringVar(®ion, "region", "", "The region in which the bucket is located.")
}
func main() {
// 解析命令列參數
flag.Parse()
// 檢查region是否為空白
if len(region) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, region required")
}
// 載入預設配置並設定憑證提供者和地區
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// 建立 OSS 用戶端
client := oss.NewClient(cfg)
var marker string = ""
// 建立 ListBucketsRequest 請求
request := &oss.ListBucketsRequest{
Prefix: oss.Ptr("example"),
MaxKeys: 10,
Marker: &marker,
}
// 列舉當前帳號所有地區下的儲存空間
for {
lsRes, err := client.ListBuckets(context.TODO(), request)
if err != nil {
log.Fatalf("Failed to list buckets: %v", err)
}
for _, bucket := range lsRes.Buckets {
log.Printf("Bucket: %s", *bucket.Name)
}
if !lsRes.IsTruncated {
break
}
marker = *lsRes.NextMarker
}
log.Println("List buckets successfully!")
}
列舉指定marker之後的儲存空間
使用分頁器Paginator
您可以使用以下代碼列舉當前帳號所有地區下，名稱的字母序排在example-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 // 儲存地區
)
// init函數用於初始化命令列參數
func init() {
flag.StringVar(®ion, "region", "", "The region in which the bucket is located.")
}
func main() {
// 解析命令列參數
flag.Parse()
// 檢查region是否為空白
if len(region) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, region required")
}
// 載入預設配置並設定憑證提供者和地區
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// 建立OSS用戶端
client := oss.NewClient(cfg)
// 建立列出儲存空間的請求
request := &oss.ListBucketsRequest{
Marker: oss.Ptr("example-bucket"), // 設定marker為"example-bucket"，從該marker開始列出儲存空間
}
// 建立分頁器
p := client.NewListBucketsPaginator(request)
var i int
log.Println("Buckets:")
// 遍曆分頁器中的每一頁
for p.HasNext() {
i++
// 擷取下一頁的資料
page, err := p.NextPage(context.TODO())
if err != nil {
log.Fatalf("failed to get page %v, %v", i, err)
}
// 列印該頁中的每個儲存空間的資訊
for _, b := range page.Buckets {
log.Printf("Bucket: %v, StorageClass: %v, Location: %v\n", oss.ToString(b.Name), oss.ToString(b.StorageClass), oss.ToString(b.Location))
}
}
}
使用ListBuckets
您可以使用以下代碼列舉當前帳號所有地區下，名稱的字母序排在example-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 // 儲存地區
)
// init 函數用於初始化命令列參數
func init() {
flag.StringVar(®ion, "region", "", "The region in which the bucket is located.")
}
func main() {
// 解析命令列參數
flag.Parse()
// 檢查region是否為空白
if len(region) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, region required")
}
// 載入預設配置並設定憑證提供者和地區
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// 建立 OSS 用戶端
client := oss.NewClient(cfg)
var marker string = "example-bucket"
// 建立 ListBucketsRequest 請求
request := &oss.ListBucketsRequest{
Marker: &marker,
}
// 列舉當前帳號所有地區下的儲存空間
for {
lsRes, err := client.ListBuckets(context.TODO(), request)
if err != nil {
log.Fatalf("Failed to list buckets: %v", err)
}
for _, bucket := range lsRes.Buckets {
log.Printf("Bucket: %s", *bucket.Name)
}
if !lsRes.IsTruncated {
break
}
marker = *lsRes.NextMarker
}
log.Println("List buckets successfully!")
}
列舉指定個數的儲存空間
使用ListBuckets
您可以使用以下代碼列舉當前帳號所有地區下的儲存空間，並指定每次分頁返回的最大數量。
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 // 儲存地區
)
// init 函數用於初始化命令列參數
func init() {
flag.StringVar(®ion, "region", "", "The region in which the bucket is located.")
}
func main() {
// 解析命令列參數
flag.Parse()
// 檢查region是否為空白
if len(region) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, region required")
}
// 載入預設配置並設定憑證提供者和地區
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// 建立 OSS 用戶端
client := oss.NewClient(cfg)
var marker string = ""
// 建立 ListBucketsRequest 請求
request := &oss.ListBucketsRequest{
Marker: &marker,
MaxKeys: 10, // 每次列舉返回的最大數量
}
// 列舉當前帳號所有地區下的儲存空間
for {
lsRes, err := client.ListBuckets(context.TODO(), request)
if err != nil {
log.Fatalf("Failed to list buckets: %v", err)
}
for _, bucket := range lsRes.Buckets {
log.Printf("Bucket: %s", *bucket.Name)
}
if !lsRes.IsTruncated {
break
}
marker = *lsRes.NextMarker
}
log.Println("List buckets successfully!")
}
相關文檔
關於列舉儲存空間的完整範例程式碼，請參見GitHub樣本。
關於進階版列舉儲存空間的API介面，請參見NewListBucketsPaginator。
關於基礎版列舉儲存空間的API介面，請參見ListBuckets。
關於分頁器的更多資訊，請參見開發人員指南。