Go獲取存儲空間的存儲容量
本文介紹如何獲取指定存儲空間(Bucket)的存儲容量以及Bucket內(nèi)不同存儲類型文件(Object)的數(shù)量及其存儲容量。
注意事項(xiàng)
本文示例代碼以華東1(杭州)的地域ID
cn-hangzhou
為例,默認(rèn)使用外網(wǎng)Endpoint,如果您希望通過與OSS同地域的其他阿里云產(chǎn)品訪問OSS,請使用內(nèi)網(wǎng)Endpoint。關(guān)于OSS支持的Region與Endpoint的對應(yīng)關(guān)系,請參見OSS地域和訪問域名。本文以從環(huán)境變量讀取訪問憑證為例。如何配置訪問憑證,請參見配置訪問憑證。
方法定義
func (c *Client) GetBucketStat(ctx context.Context, request *GetBucketStatRequest, optFns ...func(*Options)) (*GetBucketStatResult, error)
請求參數(shù)列表
參數(shù)名 | 類型 | 說明 |
ctx | context.Context | 請求的上下文,可以用來設(shè)置請求的總時限 |
request | *GetBucketStatRequest | 設(shè)置具體接口的請求參數(shù),例如bucket名稱,具體請參見GetBucketStatRequest |
optFns | ...func(*Options) | (可選)接口級的配置參數(shù), 請參見Options |
返回值列表
返回值名 | 類型 | 說明 |
result | *GetBucketStatResult | 接口返回值,當(dāng) err 為nil 時有效,具體請參見GetBucketStatResult |
err | error | 請求的狀態(tài),當(dāng)請求失敗時,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 // 存儲區(qū)域
bucketName string // 存儲空間名稱
)
// init函數(shù)用于初始化命令行參數(shù)
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() {
// 解析命令行參數(shù)
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")
}
// 加載默認(rèn)配置并設(shè)置憑證提供者和區(qū)域
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// 創(chuàng)建OSS客戶端
client := oss.NewClient(cfg)
// 創(chuàng)建獲取存儲空間存儲容量的請求
request := &oss.GetBucketStatRequest{
Bucket: oss.Ptr(bucketName), // 存儲空間名稱
}
// 執(zhí)行獲取存儲空間存儲容量的操作并處理結(jié)果
result, err := client.GetBucketStat(context.TODO(), request)
if err != nil {
log.Fatalf("failed to get bucket stat %v", err)
}
// 打印獲取存儲空間存儲容量的結(jié)果
log.Printf("get bucket stat result:%#v\n", result)
}
常用存儲容量信息列表
參數(shù) | 描述 |
Storage | 存儲空間總存儲量,單位為字節(jié) |
ObjectCount | 存儲空間中總的Object數(shù)量 |
MultipartUploadCount | 存儲空間中已經(jīng)初始化但還未完成或者還未中止的分片上傳數(shù)量 |
LiveChannelCount | 存儲空間中Live Channel的數(shù)量 |
LastModifiedTime | 此次調(diào)用獲取到的存儲信息的時間點(diǎn),格式為時間戳,單位為秒 |
StandardStorage | 標(biāo)準(zhǔn)存儲類型Object的存儲量,單位為字節(jié) |
StandardObjectCount | 標(biāo)準(zhǔn)存儲類型Object數(shù)量 |
InfrequentAccessStorage | 低頻存儲類型Object的計(jì)費(fèi)存儲量,單位為字節(jié) |
InfrequentAccessRealStorage | 低頻存儲類型Object的實(shí)際存儲量,單位為字節(jié) |
InfrequentAccessObjectCount | 低頻存儲類型Object數(shù)量 |
ArchiveStorage | 歸檔存儲類型Object的計(jì)費(fèi)存儲量,單位為字節(jié) |
ArchiveRealStorage | 歸檔存儲類型Object的實(shí)際存儲量,單位為字節(jié) |
ArchiveObjectCount | 歸檔存儲類型Object數(shù)量 |
ColdArchiveStorage | 冷歸檔存儲類型Object的計(jì)費(fèi)存儲量,單位為字節(jié) |
ColdArchiveRealStorage | 冷歸檔存儲類型Object的實(shí)際存儲量,單位為字節(jié) |
ColdArchiveObjectCount | 冷歸檔存儲類型Object數(shù)量 |
相關(guān)文檔
關(guān)于獲取存儲空間信息的完整示例代碼,請參見Github示例。
關(guān)于獲取存儲空間信息的API接口,請參見GetBucketStat。