Go获取存储空间的信息

本文介绍如何通过OSS Go SDK获取指定存储空间的访问跟踪状态信息、地域、创建日期、读写权限、拥有者的名称和ID、存储类型、数据容灾类型、外网域名、内网域名、跨区域复制状态、版本控制状态、加密方式等内容,以便进行相应操作。

注意事项

  • 本文示例代码以华东1(杭州)的地域IDcn-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

设置具体接口的请求参数,

请参见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(&region, "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.Owner.ID:存储空间拥有者的用户ID

  • BucketInfo.Owner.DisplayName:存储空间拥有者名称

BucketInfo.StorageClass

存储空间存储类型

BucketInfo.SseRule

包含以下参数:

  • BucketInfo.SseRule.KMSDataEncryption:是否使用KMS加密

  • BucketInfo.SseRule.KMSMasterKeyID:当前使用的KMS密钥ID

  • BucketInfo.SseRule.SSEAlgorithm:服务器端默认加密方式

BucketInfo.Versioning

存储空间版本控制状态

BucketInfo.CrossRegionReplication

存储空间跨区域复制状态

相关文档

  • 关于存储空间的更多信息,请参见存储空间概述

  • 关于获取存储空间信息的完整示例代码,请参见GitHub示例

  • 关于获取存储空间信息的API接口说明,请参见GetBucketInfo