本文介紹如何列舉當前賬號所有地域下符合指定條件的存儲空間。
注意事項
本文示例代碼以華東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。
關于分頁器的更多信息,請參見開發者指南。