九游平台/ 对象存储服务 obs/ sdk参考/ go/ / 设置对象元数据(go sdk)
更新时间：2024-08-26 gmt 08:00

设置对象元数据(go sdk)-九游平台

功能说明

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

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

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

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

接口约束

  • 您必须是桶拥有者或拥有设置对象元数据的权限，才能设置对象元数据。建议使用iam或桶策略进行授权，如果使用iam则需授予obs:object:modifyobjectmetadata权限，如果使用桶策略则需授予modifyobjectmetadata权限。相关授权方式介绍可参见obs权限控制概述，配置方式详见、。
  • 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编码为：中文，则响应为x-obs-meta-中文: 中文

默认取值：

无
表3 storageclasstype

常量名

原始值

说明

storageclassstandard

standard

标准存储。

标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（<1mb），且需要频繁访问数据的业务场景。

storageclasswarm

warm

低频访问存储。

低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。

storageclasscold

cold

归档存储。

归档存储适用于很少访问（平均一年访问一次）数据的业务场景。

storageclassdeeparchive

deep_archive

深度归档存储（受限公测）

适用于长期不访问（平均几年访问一次）数据的业务场景。

返回结果说明

表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编码为：中文，则响应为x-obs-meta-中文: 中文

默认取值：

无
表6 metadatadirectivetype

常量名

原始值

说明

copymetadata

copy

复制对象时，复制源对象属性。

replacemetadata

replace

复制对象时，重写源对象属性。
表7 storageclasstype

常量名

原始值

说明

storageclassstandard

standard

标准存储。

标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（<1mb），且需要频繁访问数据的业务场景。

storageclasswarm

warm

低频访问存储。

低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。

storageclasscold

cold

归档存储。

归档存储适用于很少访问（平均一年访问一次）数据的业务场景。

storageclassdeeparchive

deep_archive

深度归档存储（受限公测）

适用于长期不访问（平均几年访问一次）数据的业务场景。

代码示例

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
packagemain
import(
"fmt"
"os"
obs"github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
funcmain(){
//推荐通过环境变量获取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)*/)
iferr!=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)
iferr==nil{
fmt.printf("set object(%s)'s metadata successful with bucket(%s)!\n",input.key,input.bucket)
fmt.printf("requestid:%s\n",output.requestid)
return
}
fmt.printf("set object(%s)'s metadata fail with bucket(%s)!\n",input.key,input.bucket)
ifobserror,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)
}
}

相关链接

  • 关于添加、修改或删除桶中已经上传的对象的元数据的api说明，请参见修改对象元数据。
  • 更多关于设置对象元数据的示例代码，请参见。
  • 获取对象元数据过程中返回的错误码含义、问题原因及处理措施可参考obs错误码。
父主题：

相关文档

网站地图