本文介紹如何通過OSS Go SDK擷取指定儲存空間的訪問跟蹤狀態資訊、地區、建立日期、讀寫權限、擁有者的名稱和ID、儲存類型、資料容災類型、外網網域名稱、內網網域名稱、跨地區複製狀態、版本控制狀態、加密方式等內容,以便進行相應操作。
注意事項
本文範例程式碼以華東1(杭州)的地區ID
cn-hangzhou
為例,預設使用外網Endpoint,如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS地區和訪問網域名稱。本文以從環境變數讀取存取憑證為例。如何配置訪問憑證,請參見配置訪問憑證。
要擷取儲存空間的資訊,您必須具有
oss:GetBucketInfo
許可權。具體操作,請參見為RAM使用者授權自訂的權限原則。
方法定義
func (c *Client) GetBucketInfo(ctx context.Context, request *GetBucketInfoRequest, optFns ...func(*Options)) (*GetBucketInfoResult, error)
請求參數列表
參數名 | 類型 | 說明 |
ctx | context.Context | 請求的上下文,可以用來佈建要求的總時限 |
request | *GetBucketInfoRequest | 設定具體介面的請求參數, |
optFns | ...func(*Options) | (可選)介面級的配置參數, 請參見Options |
傳回值列表
傳回值名 | 類型 | 說明 |
result | *GetBucketInfoResult | 介面傳回值,當 err 為nil 時有效,具體請參見GetBucketInfoResult |
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 // 儲存空間名稱
)
// init函數用於初始化命令列參數
func init() {
flag.StringVar(®ion, "region", "", "The region in which the bucket is located.")
flag.StringVar(&bucketName, "bucket", "", "The `name` of the bucket.")
}
func main() {
// 解析命令列參數
flag.Parse()
// 檢查bucket名稱是否為空白
if len(bucketName) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, bucket name required")
}
// 檢查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.GetBucketInfoRequest{
Bucket: oss.Ptr(bucketName), // 儲存空間名稱
}
// 執行擷取儲存空間資訊的操作並處理結果
result, err := client.GetBucketInfo(context.TODO(), request)
if err != nil {
log.Fatalf("failed to get bucket info %v", err)
}
// 列印擷取儲存空間資訊的結果
log.Printf("get bucket info result:%v\n", result.BucketInfo)
}
常用儲存空間資訊列表
參數 | 描述 |
BucketInfo.Name | 儲存空間名稱 |
BucketInfo.AccessMonitor | 儲存空間訪問跟蹤狀態資訊 |
BucketInfo.Location | 儲存空間所在地區 |
BucketInfo.CreationDate | 儲存空間建立日期 |
BucketInfo.ExtranetEndpoint | 儲存空間外網網域名稱 |
BucketInfo.IntranetEndpoint | 同地區ECS訪問儲存空間的內網網域名稱 |
BucketInfo.ACL | 儲存空間讀寫權限 |
BucketInfo.RedundancyType | 儲存空間資料容災類型 |
BucketInfo.Owner | 包含以下參數:
|
BucketInfo.StorageClass | 儲存空間儲存類型 |
BucketInfo.SseRule | 包含以下參數:
|
BucketInfo.Versioning | 儲存空間版本控制狀態 |
BucketInfo.CrossRegionReplication | 儲存空間跨地區複製狀態 |
相關文檔
關於儲存空間的更多資訊,請參見儲存空間概述。
關於擷取儲存空間資訊的完整範例程式碼,請參見GitHub樣本。
關於擷取儲存空間資訊的API介面說明,請參見GetBucketInfo。