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

获取对象元数据(go sdk)-九游平台

功能说明

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

当前仅支持系统定义的元数据。系统定义的元数据又分为两种类别：系统控制和用户控制。

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

接口约束

  • 您必须是桶拥有者或拥有获取对象元数据的权限，才能获取对象元数据。建议使用iam或桶策略进行授权，如果使用iam则需授予obs:object:getobject权限，如果使用桶策略则需授予getobject权限。相关授权方式介绍可参见obs权限控制概述，配置方式详见、。
  • obs支持的region与endpoint的对应关系，详细信息请参见。
  • 拥有对象读权限的用户可以执行head操作命令获取对象元数据，返回信息包含对象的元数据信息。

方法定义

func (obsclient obsclient) getobjectmetadata(input *getobjectmetadatainput, extensions...extensionoptions) (output *getobjectmetadataoutput, err error)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

input

*getobjectmetadatainput

必选

参数解释：

获取对象元数据请求参数，详情参考getobjectmetadatainput。

extensions

可选

参数解释：

拓展配置项。通过调用拓展配置项为对应请求配置额外的拓展请求头，详情参考。
表2 getobjectmetadatainput

参数名称

参数类型

是否必选

描述

bucket

string

必选

参数解释：

桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用ip地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。
  • 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

key

string

必选

参数解释：

对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。

例如，您对象的访问地址为examplebucket.obs.cn-north-4. myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

versionid

string

可选

参数解释：

对象的版本号。例如：g001117fce89978b0000401205d5dc9a。

取值范围：

长度为32的字符串。

默认取值：

无

sseheader

ssecheader

可选

参数解释：

服务端解密头信息，详情参考ssecheader。
表3 ssecheader

参数名称

参数类型

是否必选

描述

encryption

string

作为请求参数时必选

参数解释：

表示服务端加密是sse-c方式。对象使用sse-c加密方式。

取值范围：

可选值：aes256，即选择sse-c方式加密对象。

默认取值：

无

key

string

作为请求参数时必选

参数解释：

sse-c方式下加密使用的密钥，该密钥用于加密对象。

约束限制：

该头域由256bit的密钥经过base64编码得到，示例：k7qkypbkm5 hca27fsnkunnvaobncnlht/rcb2o/9cw=

默认取值：

无

keymd5

string

作为请求参数时可选

参数解释：

sse-c方式下加密使用密钥的md5值，该值用于验证密钥传输过程中是否出错。

约束限制：

由密钥值经过md5加密再经过base64编码后得到，示例：4xvb3tbntn tieva0/fgaq==

默认取值：

无

返回结果说明

表4 返回结果

参数名称

参数类型

描述

output

*getobjectmetadataoutput

参数解释：

接口返回信息，详情参考getobjectmetadataoutput。

err

error

参数解释：

接口返回错误信息。
表5 getobjectmetadataoutput

参数名称

参数类型

描述

statuscode

int

参数解释：

http状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见。

默认取值：

无

requestid

string

参数解释：

obs服务端返回的请求id。

默认取值：

无

responseheaders

map[string][]string

参数解释：

http响应头信息。

默认取值：

无

storageclass

storageclasstype

参数解释：

复制时设置对象的存储类型。如果未设置此头域，则以桶的默认存储类型作为对象的存储类型。

取值范围：

可选择的存储类型参见storageclasstype。

默认取值：

无

alloworigin

string

参数解释：

如果请求中的origin满足桶的cors规则，则返回cors规则中的allowedorigin。allowedorigin指定允许的跨域请求的来源，即允许来自该域名下的请求访问该对象。

约束限制：

表示域名的字符串，每个匹配规则允许使用最多一个“*”通配符。例如：https://*.vbs.example.com。

默认取值：

无

allowheader

string

参数解释：

如果请求的requestheader满足桶的cors规则，则返回cors规则中的allowedheader。allowedheader是指允许的跨域请求的头域。只有匹配上允许的头域中的配置，才被视为是合法的cors请求。

约束限制：

最多可填写一个“*”通配符，不支持&、:、<、空格以及中文字符。

默认取值：

无

allowmethod

string

参数解释：

桶cors规则中的allowedmethod。allowedmethod指允许的跨域请求http方法，即桶和对象的几种操作类型。

取值范围：

支持以下http方法：

  • get
  • put
  • head
  • post
  • delete

默认取值：

无

exposeheader

string

参数解释：

桶cors规则中的exposeheader。exposeheader是指cors规则允许响应中可返回的附加头域，给客户端提供额外的信息。默认情况下浏览器只能访问以下头域：content-length、content-type，如果需要访问其他头域，需要在附加头域中配置。

约束限制：

不支持*、&、:、<、空格以及中文字符。

默认取值：

无

maxageseconds

int

参数解释：

桶cors规则中的maxageseconds。maxageseconds指请求来源的客户端可以对跨域请求返回结果的缓存时间。

约束限制：

每个corsrule可以包含至多一个maxageseconds。

取值范围：

0~（231-1），单位：秒。

默认取值：

100，单位：秒。

contentlength

int64

参数解释：

对象数据的长度。

取值范围：

0~（263-1），单位：字节。

默认取值：

无

contenttype

string

参数解释：

对象的文件类型（mime类型）。content-type（mime）用于标识发送或接收数据的类型，浏览器根据该参数来决定数据的打开方式。

取值范围：

常见的content-type（mime）列表参见

默认取值：

如果您在上传object时未指定content-type，sdk会根据指定object名称的后缀名来判定文件类型并自动填充content-type。

lastmodified

time.time

参数解释：

对象的最近一次修改时间。

约束限制：

日期格式必须为iso8601的格式。 例如：2018-01-01t00:00:00.000z，表示最后一次修改时间为2018-01-01t00:00:00.000z。

默认取值：

无

etag

string

参数解释：

对象的etag值。对象的base64编码的128位md5摘要。etag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时etag为a，下载对象时etag为b，则说明对象内容发生了变化。etag只反映变化的内容，而不是其元数据。上传的对象或拷贝操作创建的对象，都有唯一的etag。

约束限制：

当对象是服务端加密的对象时，etag值不是对象的md5值。

取值范围：

长度为32的字符串。

默认取值：

无

versionid

string

参数解释：

对象的版本号。

取值范围：

长度为32的字符串。

默认取值：

无

restore

string

参数解释：

标识对象的恢复状态。对象为归档存储或深度归档存储类型，并且处于正在恢复或已经恢复时，会返回此头域。

示例：正在恢复ongoing-request="true"；已恢复 ongoing-request="false", expiry-date="wed, 7 nov 2012 00:00:00 gmt"。其中expiry-date表示对象恢复后的失效时间。

约束限制：

归档或深度归档存储类型对象的恢复状态，如果对象不为归档或深度归档存储类型，则该值为空。

默认取值：

无

expiration

string

参数解释：

对象的详细过期信息。比如："expiry-date=\"mon, 11 sep 2023 00:00:00 gmt\""

默认取值：

无

sseheader

ssecheader

或

ssekmsheader

参数解释：

服务端加密头信息。sse-c加密方式详情参见ssecheader，sse-kms加密方式详情参见ssekmsheader。

websiteredirectlocation

string

参数解释：

当桶设置了website配置，可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的url。

例如，重定向请求到桶内另一对象：

websiteredirectlocation:/anotherpage.html

或重定向请求到一个外部url：

websiteredirectlocation:http://www.example.com/

obs将这个值从头域中取出，保存在对象的元数据“websiteredirectlocation”中。

约束限制：

  • 必须以“/”、“http://”或“https://”开头，长度不超过2kb。
  • obs仅支持为桶根目录下的对象设置重定向，不支持为桶中文件夹下的对象设置重定向。

默认取值：

无

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 storageclasstype

常量名

原始值

说明

storageclassstandard

standard

标准存储。

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

storageclasswarm

warm

低频访问存储。

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

storageclasscold

cold

归档存储。

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

storageclassdeeparchive

deep_archive

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

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

参数名称

参数类型

是否必选

描述

encryption

string

作为请求参数时必选

参数解释：

表示服务端加密是sse-c方式。对象使用sse-c加密方式。

取值范围：

可选值：aes256，即选择sse-c方式加密对象。

默认取值：

无

key

string

作为请求参数时必选

参数解释：

sse-c方式下加密使用的密钥，该密钥用于加密对象。

约束限制：

该头域由256bit的密钥经过base64编码得到，示例：k7qkypbkm5 hca27fsnkunnvaobncnlht/rcb2o/9cw=

默认取值：

无

keymd5

string

作为请求参数时可选

参数解释：

sse-c方式下加密使用密钥的md5值，该值用于验证密钥传输过程中是否出错。

约束限制：

由密钥值经过md5加密再经过base64编码后得到，示例：4xvb3tbntn tieva0/fgaq==

默认取值：

无
表8 ssekmsheader

参数名称

参数类型

是否必选

描述

encryption

string

作为请求参数时必选

参数解释：

表示服务端加密是sse-kms方式。对象使用sse-kms方式加密。

取值范围：

可选值：kms，即选择sse-kms方式加密对象。

默认取值：

无

key

string

作为请求参数时可选

参数解释：

sse-kms加密方式下使用的kms主密钥的id值。

取值范围：

有效值支持两种格式：

  1. regionid:domainid(账号id):key/key_id
  2. key_id

其中：

  • regionid是使用密钥所属region的id，可在页面获取；
  • domainid是使用密钥所属账号的账号id，获取方法参见；
  • key_id是从数据加密服务创建的密钥id，获取方法请参见查看密钥。

默认取值：

  • 如果用户没有提供该头域，那么默认的主密钥将会被使用。
  • 如果默认主密钥不存在，将默认创建并使用。

代码示例

本示例用于获取名为examplebucket桶下example/objectname对象的元数据信息

 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
 
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.withsignature(obs.signatureobs)/*, obs.withsecuritytoken(securitytoken)*/)
iferr!=nil{
fmt.printf("create obsclient error, errmsg: %s",err.error())
}
input:=&obs.getobjectmetadatainput{}
// 指定存储桶名称
input.bucket="examplebucket"
// 指定对象，此处以 example/objectname 为例。
input.key="example/objectname"
// 获取对象自定义元数据
output,err:=obsclient.getobjectmetadata(input)
iferr==nil{
fmt.printf("get object(%s)'s metadata successful with bucket(%s)!\n",input.key,input.bucket)
fmt.printf("storageclass:%s, etag:%s, contenttype:%s, contentlength:%d, lastmodified:%s\n",
output.storageclass,output.etag,output.contenttype,output.contentlength,output.lastmodified)
// 获取对象自定义元数据
fmt.printf("metadata:%v\n",output.metadata)
return
}
fmt.printf("get 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错误码。
父主题：

相关文档

网站地图