本文介绍如何添加、查看、批量列举和删除存储空间（Bucket）的清单（Inventory）配置。
注意事项
本文示例代码以华东1（杭州）的地域ID
cn-hangzhou为例，默认使用外网Endpoint，如果您希望通过与OSS同地域的其他阿里云产品访问OSS，请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系，请参见OSS地域和访问域名。本文以从环境变量读取访问凭证为例。如何配置访问凭证，请参见配置访问凭证。
请确保您拥有调用添加、查看、列举和删除存储空间清单配置的权限。Bucket所有者默认拥有此类权限，如果您无此类权限，请先向Bucket所有者申请对应操作的权限。
单个Bucket最多只能有1000条清单配置。
配置清单的源Bucket与存放导出的清单文件所在的目标Bucket必须位于同一个Region。
示例代码
添加清单配置
以下代码用于为某个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 // 存储区域
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()
var (
accountId = "account id of the bucket" // 存储空间所有者授予的账户ID，例如109885487000****
inventoryId = "inventory id" // 由用户指定的清单名称，清单名称在当前Bucket下必须全局唯一
)
// 检查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)
// 创建设置存储空间清单的请求
putRequest := &oss.PutBucketInventoryRequest{
Bucket: oss.Ptr(bucketName), // 存储空间名称
InventoryId: oss.Ptr(inventoryId), // 由用户指定的清单名称
InventoryConfiguration: &oss.InventoryConfiguration{
Id: oss.Ptr(inventoryId), // 由用户指定的清单名称
IsEnabled: oss.Ptr(true), // 启用清单配置
Filter: &oss.InventoryFilter{
Prefix: oss.Ptr("filterPrefix"), // 设置清单筛选规则，指定筛选Object的前缀
LastModifyBeginTimeStamp: oss.Ptr(int64(1637883649)), // 最后修改开始时间戳
LastModifyEndTimeStamp: oss.Ptr(int64(1638347592)), // 最后修改结束时间戳
LowerSizeBound: oss.Ptr(int64(1024)), // 文件大小下限（字节）
UpperSizeBound: oss.Ptr(int64(1048576)), // 文件大小上限（字节）
StorageClass: oss.Ptr("Standard,IA"), // 存储类型
},
Destination: &oss.InventoryDestination{
OSSBucketDestination: &oss.InventoryOSSBucketDestination{
Format: oss.InventoryFormatCSV, // 导出清单文件的文件格式
AccountId: oss.Ptr(accountId), // 存储空间所有者授予的账户ID，例如109885487000****
RoleArn: oss.Ptr("acs:ram::" + accountId + ":role/AliyunOSSRole"), // 存储空间所有者授予操作权限的角色名，比如acs:ram::109885487000****:role/ram-test
Bucket: oss.Ptr("acs:oss:::" + bucketName), // 存放导出的清单结果的Bucket名称
Prefix: oss.Ptr("export/"), // 存放清单结果的存储路径前缀
},
},
Schedule: &oss.InventorySchedule{
Frequency: oss.InventoryFrequencyDaily, // 清单文件导出的周期（每天）
},
IncludedObjectVersions: oss.Ptr("All"), // 是否在清单中包含Object的所有版本信息
},
}
// 执行设置存储空间清单的请求
putResult, err := client.PutBucketInventory(context.TODO(), putRequest)
if err != nil {
log.Fatalf("failed to put bucket inventory %v", err)
}
// 打印设置存储空间清单的结果
log.Printf("put bucket inventory result:%#v\n", putResult)
}
查看清单配置
以下代码用于查看某个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 // 存储区域
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()
// 填写用户指定的清单名称
var inventoryId = "inventory id"
// 检查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.GetBucketInventoryRequest{
Bucket: oss.Ptr(bucketName),
InventoryId: oss.Ptr(inventoryId),
}
// 执行获取存储空间清单配置的操作并处理结果
result, err := client.GetBucketInventory(context.TODO(), request)
if err != nil {
log.Fatalf("failed to get bucket inventory %v", err)
}
// 打印获取存储空间清单配置的结果
log.Printf("get bucket inventory result:%#v\n", result)
}
列举清单配置
说明
单次请求最多可获取100条清单配置项内容。若需获取超过100条清单配置项，则需发送多次请求，并保留相应的Token，作为下一次请求的参数。
以下代码用于列举某个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 // 存储区域
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()
// 检查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.ListBucketInventoryRequest{
Bucket: oss.Ptr(bucketName),
}
// 执行列出存储空间清单的操作并处理结果
result, err := client.ListBucketInventory(context.TODO(), request)
if err != nil {
log.Fatalf("failed to list bucket inventory %v", err)
}
// 打印列出存储空间清单的结果
log.Printf("list bucket inventory 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 // 存储区域
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()
// 填写用户指定的清单名称
var inventoryId = "inventory id"
// 检查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.DeleteBucketInventoryRequest{
Bucket: oss.Ptr(bucketName),
InventoryId: oss.Ptr(inventoryId),
}
// 执行删除存储空间清单配置的操作并处理结果
result, err := client.DeleteBucketInventory(context.TODO(), request)
if err != nil {
log.Fatalf("failed to delete bucket inventory %v", err)
}
// 打印删除存储空间清单配置的结果
log.Printf("delete bucket inventory result:%#v\n", result)
}
相关文档
关于添加存储空间清单配置的API接口说明，请参见PutBucketInventory。
关于查看存储空间清单配置的API接口说明，请参见GetBucketInventory。
关于批量列举存储空间清单配置的API接口说明，请参见ListBucketInventory。
关于删除存储空间清单配置的API接口说明，请参见DeleteBucketInventory。
文档内容是否对您有帮助？