华为云对象存储OBS设置对象元数据(Go SDK)_云淘科技

华为云云存储

12 月 22, 2023

127 0

功能说明

元数据（Metadata）为描述对象属性的信息，是一组名称值对，用作对象管理的一部分。

当前仅支持系统定义的元数据。

系统定义的元数据又分为两种类别：系统控制和用户控制。如Last-Modified日期等数据由系统控制，不可修改；如为对象配置的ContentLanguage，用户可以通过接口进行修改。

对指定桶中的对象发送HEAD请求，设置对象的元数据信息。

接口约束

您必须是桶拥有者或拥有设置对象元数据的权限，才能设置对象元数据。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:ModifyObjectMetaData权限，如果使用桶策略则需授予ModifyObjectMetaData权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。
OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。
当桶开启多版本控制时，最新版本的对象支持设置元数据，历史版本的对象不支持设置元数据。
对于存储类别为归档存储对象，不能对其设置对象的元数据。

方法定义

func (obsClient ObsClient) SetObjectMetadata(input *SetObjectMetadataInput) (output *SetObjectMetadataOutput, err error)

请求参数说明

表1 请求参数列表
参数名称	参数类型	是否必选	描述
input	*SetObjectMetadataInput	必选	参数解释：设置对象元数据请求参数。详情参见SetObjectMetadataInput。

表2 SetObjectMetadataInput
参数名称	参数类型	是否必选	描述
Bucket	string	必选	参数解释：桶名。约束限制：桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。禁止使用IP地址。禁止以“-”或“.”开头及结尾。禁止两个“.”相邻（如：“my..bucket”）。禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。取值范围：长度为3～63个字符。
Key	string	必选	参数解释：对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。例如，您对象的访问地址为examplebucket.obs.cn-north-4. myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。取值范围：长度大于0且不超过1024的字符串。默认取值：无
VersionId	string	可选	参数解释：对象的版本号。例如：G001117FCE89978B0000401205D5DC9A。取值范围：长度为32的字符串。默认取值：无
CacheControl	string	可选	参数解释：响应中的Cache-Control头。指定对象被下载时的网页的缓存行为。默认取值：无
ContentDisposition	string	可选	参数解释：响应中的Content-Disposition头。指定对象被下载时的名称。默认取值：无
ContentEncoding	string	可选	参数解释：响应中的Content-Encoding头。指定对象被下载时的内容编码格式。默认取值：无
ContentLanguage	string	可选	参数解释：响应中的Content-Language头。指定对象被下载时的内容语言格式。默认取值：无
ContentType	string	可选	参数解释：响应中的Content-Type头。指定对象被下载时的文件类型。默认取值：无
Expires	string	可选	参数解释：响应中的Expires头。指定对象被下载时的网页的缓存过期时间。默认取值：无
WebsiteRedirectLocation	string	可选	参数解释：当桶设置了Website配置，可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL。例如，重定向请求到桶内另一对象： WebsiteRedirectLocation:/anotherPage.html 或重定向请求到一个外部URL： WebsiteRedirectLocation:http://www.example.com/ OBS将这个值从头域中取出，保存在对象的元数据“WebsiteRedirectLocation”中。约束限制：必须以“/”、“http://”或“https://”开头，长度不超过2KB。 OBS仅支持为桶根目录下的对象设置重定向，不支持为桶中文件夹下的对象设置重定向。默认取值：无
StorageClass	StorageClassType	可选	参数解释：指定对象的存储类型。取值范围：可选择的存储类型参见StorageClassType。默认取值：无
Metadata	map[string]string	可选	参数解释：对象的自定义元数据。OBS支持用户使用以“x-obs-meta-”开头的消息头来加入自定义的元数据，以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时，加入的自定义元数据将会在返回的消息头中出现。约束限制：所有自定义元数据大小的总和不超过8K。单个自定义元数据大小的计算方式为：每个键和值的UTF-8 编码中的字节总数。自定义元数据的key值不区分大小写，OBS统一转为小写进行存储。value值区分大小写。自定义元数据key-value对都必须符合US-ASCII。如果一定要使用非ASCII码或不可识别字符，需要客户端自行做编解码处理，可以采用URL编码或者Base64编码，服务端不会做解码处理。例如x-obs-meta-中文：中文经URL编码后发送，“中文”的URL编码为：%E4%B8%AD%E6%96%87，则响应为x-obs-meta-%E4%B8%AD%E6%96%87: %E4%B8%AD%E6%96%87 默认取值：无

表3 StorageClassType
常量名	原始值	说明
StorageClassStandard	STANDARD	标准存储。标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（<1MB），且需要频繁访问数据的业务场景。
StorageClassWarm	WARM	低频访问存储。低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。
StorageClassCold	COLD	归档存储。归档存储适用于很少访问（平均一年访问一次）数据的业务场景。

返回结果说明

表4 返回结果
参数名称	参数类型	描述
output	*SetObjectMetadataOutput	参数解释：接口返回信息。详情参见SetObjectMetadataOutput。
err	error	参数解释：接口返回错误信息。

表5 SetObjectMetadataOutput
参数名称	参数类型	描述
StatusCode	int	参数解释： HTTP状态码。取值范围：状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。默认取值：无
RequestId	string	参数解释： OBS服务端返回的请求ID。默认取值：无
ResponseHeaders	map[string][]string	参数解释： HTTP响应头信息。默认取值：无
MetadataDirective	MetadataDirectiveType	参数解释：复制源对象属性的策略。取值范围：可选择的对象属性选项参见MetadataDirectiveType。默认取值：无
CacheControl	string	参数解释：响应中的Cache-Control头。指定对象被下载时的网页的缓存行为。默认取值：无
ContentDisposition	string	参数解释：响应中的Content-Disposition头。指定对象被下载时的名称。默认取值：无
ContentEncoding	string	参数解释：响应中的Content-Encoding头。指定对象被下载时的内容编码格式。默认取值：无
ContentLanguage	string	参数解释：响应中的Content-Language头。指定对象被下载时的内容语言格式。默认取值：无
ContentType	string	参数解释：响应中的Content-Type头。指定对象被下载时的文件类型。默认取值：无
Expires	string	参数解释：响应中的Expires头。指定对象被下载时的网页的缓存过期时间。默认取值：无
WebsiteRedirectLocation	string	参数解释：当桶设置了Website配置，可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL。例如，重定向请求到桶内另一对象： WebsiteRedirectLocation:/anotherPage.html 或重定向请求到一个外部URL： WebsiteRedirectLocation:http://www.example.com/ OBS将这个值从头域中取出，保存在对象的元数据“WebsiteRedirectLocation”中。约束限制：必须以“/”、“http://”或“https://”开头，长度不超过2KB。 OBS仅支持为桶根目录下的对象设置重定向，不支持为桶中文件夹下的对象设置重定向。默认取值：无
StorageClass	StorageClassType	参数解释：复制时设置对象的存储类型。如果未设置此头域，则以桶的默认存储类型作为对象的存储类型。取值范围：可选择的存储类型参见StorageClassType。默认取值：无
Metadata	map[string]string	参数解释：对象的自定义元数据。OBS支持用户使用以“x-obs-meta-”开头的消息头来加入自定义的元数据，以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时，加入的自定义元数据将会在返回的消息头中出现。约束限制：所有自定义元数据大小的总和不超过8K。单个自定义元数据大小的计算方式为：每个键和值的UTF-8 编码中的字节总数。自定义元数据的key值不区分大小写，OBS统一转为小写进行存储。value值区分大小写。自定义元数据key-value对都必须符合US-ASCII。如果一定要使用非ASCII码或不可识别字符，需要客户端自行做编解码处理，可以采用URL编码或者Base64编码，服务端不会做解码处理。例如x-obs-meta-中文：中文经URL编码后发送，“中文”的URL编码为：%E4%B8%AD%E6%96%87，则响应为x-obs-meta-%E4%B8%AD%E6%96%87: %E4%B8%AD%E6%96%87 默认取值：无

表6 MetadataDirectiveType
常量名	原始值	说明
CopyMetadata	COPY	复制对象时，复制源对象属性。
ReplaceMetadata	REPLACE	复制对象时，重写源对象属性。

表7 StorageClassType
常量名	原始值	说明
StorageClassStandard	STANDARD	标准存储。标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（<1MB），且需要频繁访问数据的业务场景。
StorageClassWarm	WARM	低频访问存储。低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。
StorageClassCold	COLD	归档存储。归档存储适用于很少访问（平均一年访问一次）数据的业务场景。

代码示例

本示例用于设置examplebucket桶中的example/objectname对象元数据，并且将对象MIME类型设置成image/jpeg，对象存储类型指定为归档存储，并设置自定义元数据。

package main
import (
    "fmt"
    "os"
    obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
func main() {
    //推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。
    //您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html。
    ak := os.Getenv("AccessKeyID")
    sk := os.Getenv("SecretAccessKey")
    // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。
    // securityToken := os.Getenv("SecurityToken")
   // endpoint填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写。
    endPoint := "https://obs.cn-north-4.myhuaweicloud.com"
    // 创建obsClient实例
    // 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。
    obsClient, err := obs.New(ak, sk, endPoint /*, obs.WithSecurityToken(securityToken)*/)
    if err != nil {
        fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }
    input := &obs.SetObjectMetadataInput{}
    // 指定存储桶名称
    input.Bucket = "examplebucket"
    // 指定对象，此处以 example/objectname 为例。
    input.Key = "example/objectname"
    // 指定对象MIME类型，这里以image/jpeg为例
    input.ContentType = "image/jpeg"
    // 指定对象存储类型，这里以obs.StorageClassCold为例
    input.StorageClass = obs.StorageClassCold
    // 指定自定义元数据
    input.Metadata = map[string]string{"property1": "property-value1", "property2": "property-value2"}
    // 设置对象元数据
    output, err := obsClient.SetObjectMetadata(input)
    if err == nil {
        fmt.Printf("Set Object(%s)'s metadata successful with bucket(%s)!
", input.Key, input.Bucket)
        fmt.Printf("RequestId:%s
", output.RequestId)
        return
    }
    fmt.Printf("Set Object(%s)'s metadata fail with bucket(%s)!
", input.Key, input.Bucket)
    if obsError, ok := err.(obs.ObsError); ok {
        fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.")
        fmt.Println(obsError.Error())
    } else {
        fmt.Println("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.")
        fmt.Println(err)
    }
}