如何设置、修改、以及获取文件元数据 - 对象存储 OSS

对象存储OSS存储的文件（Object）信息包含Key、Data和Object Meta。Object Meta是对文件的属性描述，包括HTTP标准属性（HTTP Header）和用户自定义元数据（User Meta）两种。您可以通过设置HTTP标准属性来自定义HTTP请求的策略，例如文件（Object）缓存策略、强制下载策略等。您还可以通过设置用户自定义元数据来标识Object的用途或属性等。

注意事项

本文以华东1（杭州）外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS，请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系，请参见OSS访问域名、数据中心、开放端口。
本文以从环境变量读取访问凭证为例。如何配置访问凭证，请参见配置访问凭证。
本文以OSS域名新建OSSClient为例。如果您希望通过自定义域名、STS等方式新建OSSClient，请参见初始化。
要设置文件元数据，您必须具有oss:PutObject权限；要获取文件元数据，您必须具有oss:GetObject权限。具体操作，请参见为RAM用户授权自定义的权限策略。

示例代码

上传文件时设置元数据

警告

在上传文件时设置元数据，请确保该Bucket内不存在同名文件，否则会覆盖同名文件。关于如何避免覆盖同名文件的更多信息，请参见避免覆盖同名文件。

package main

import (
	"log"
	"strings"
	"time"

	"github.com/aliyun/aliyun-oss-go-sdk/oss"
)

func main() {
	// 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
	provider, err := oss.NewEnvironmentVariableCredentialsProvider()
	if err != nil {
		log.Fatalf("Failed to create credentials provider: %v", err)
	}

	// 创建OSSClient实例。
	// yourEndpoint填写Bucket对应的Endpoint，以华东1（杭州）为例，填写为https://oss-cn-hangzhou.aliyuncs.com。其它Region请按实际情况填写。
	// yourRegion填写Bucket所在地域，以华东1（杭州）为例，填写为cn-hangzhou。其它Region请按实际情况填写。
	clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
	clientOptions = append(clientOptions, oss.Region("yourRegion"))
	// 设置签名版本
	clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
	client, err := oss.New("yourEndpoint", "", "", clientOptions...)
	if err != nil {
		log.Fatalf("Failed to create OSS client: %v", err)
	}

	// 填写Bucket名称，例如examplebucket。
	bucketName := "examplebucket" // 请替换为实际的Bucket名称
	bucket, err := client.Bucket(bucketName)
	if err != nil {
		log.Fatalf("Failed to get bucket: %v", err)
	}

	// 设置文件元数据，例如指定过期时间为2049年01月10日 23:00:00 GMT，访问权限为公共读，自定义元数据为MyProp（取值MyPropVal）。
	expires := time.Date(2049, time.January, 10, 23, 0, 0, 0, time.UTC)
	options := []oss.Option{
		oss.Expires(expires),
		oss.ObjectACL(oss.ACLPublicRead),
		oss.Meta("MyProp", "MyPropVal"),
	}

	// 使用数据流上传文件。
	// 填写Object的完整路径，完整路径中不包含Bucket名称，例如exampledir/exampleobject.txt。
	objectName := "exampledir/exampleobject.txt" // 请替换为实际的对象路径
	err = bucket.PutObject(objectName, strings.NewReader("MyObjectValue"), options...)
	if err != nil {
		log.Fatalf("Failed to upload object: %v", err)
	}

	// 获取文件元数据。
	props, err := bucket.GetObjectDetailedMeta(objectName)
	if err != nil {
		log.Fatalf("Failed to get object detailed metadata: %v", err)
	}
	log.Printf("Object Meta: %+v\n", props)
}

修改已有文件的元数据

...

// 一次修改一条元数据。
err = bucket.SetObjectMeta(objectName, oss.Meta("MyMeta", "MyMetaValue1"))
if err != nil {
	log.Fatalf("Failed to set single metadata: %v", err)
}

// 一次修改多条元数据。
options := []oss.Option{
	oss.Meta("MyMeta", "MyMetaValue2"),
	oss.Meta("MyObjectLocation", "HangZhou"),
}
err = bucket.SetObjectMeta(objectName, options...)
if err != nil {
	log.Fatalf("Failed to set multiple metadatas: %v", err)
}

// 获取文件元数据。
props, err := bucket.GetObjectDetailedMeta(objectName)
if err != nil {
	log.Fatalf("Failed to get object detailed metadata: %v", err)
}
log.Printf("Object Meta: %+v\n", props)

获取文件元数据

...

// 获取文件元数据。
props, err := bucket.GetObjectDetailedMeta(objectName)
if err != nil {
	log.Fatalf("Failed to get object detailed metadata: %v", err)
}
log.Printf("Object Meta: %+v\n", props)

常见问题

在上传文件时设置元数据，如何避免覆盖Bucket内的同名文件？

为避免覆盖Bucket内的同名文件，您可以选择以下任意方式：

开启版本控制
开启版本控制功能后，Bucket中被覆盖的文件会以历史版本的形式保存下来。您可以随时恢复历史版本文件。更多信息，请参见开启版本控制。
在上传请求中携带禁止覆盖同名文件的参数
在上传请求的Header中携带参数x-oss-forbid-overwrite，并指定其值为true。当您上传的文件与Bucket中已有的文件同名时，该文件会上传失败，并返回FileAlreadyExists错误。更多信息，请参见PutObject。

对象存储 OSS：Go管理文件元数据