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

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

功能说明

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

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

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

接口约束

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

方法定义

obsclient.getobjectmetadata(bucketname, objectkey, versionid, sseheader, origin, requestheaders, extensionheaders)

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

bucketname

str

必选

参数解释：

桶名。

约束限制：

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

默认取值：

无

objectkey

str

必选

参数解释：

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

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

取值范围：

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

默认取值：

无

versionid

str

可选

参数解释：

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

取值范围：

长度为32的字符串。

默认取值：

无

origin

str

可选

参数解释：

预请求指定的跨域请求origin（通常为域名）。

约束限制：

允许多条匹配规则，以回车换行为间隔。每个匹配规则允许使用最多一个“*”通配符。

默认取值：

无

requestheaders

str

可选

参数解释：

跨域请求可以使用的http头域。只有匹配上允许的头域中的配置，才被视为是合法的cors请求。

约束限制：

允许的头域可设置多个，多个头域之间换行隔开，每行最多可填写一个*符号，不支持&、:、<、空格以及中文字符。

默认取值：

无

sseheader

ssecheader

可选

参数解释：

服务端解密头域。

取值范围：

详见ssecheader。

默认取值：

无

extensionheaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

参考。

默认取值：

无
表2 ssecheader

参数名称

参数类型

是否必选

描述

encryption

str

必选

参数解释：

以sse-c方式加密对象。

取值范围：

aes256，即高级加密标准（advanced encryption standard，aes）。

默认取值：

无

key

str

必选

参数解释：

sse-c方式下加密的密钥，与加密方式对应，如encryption=‘aes256’，密钥就是由aes256加密算法得到的密钥。

取值范围：

长度为32字符串。

默认取值：

无

返回结果

表3 返回结果

类型

说明

getresult

参数解释：

sdk公共结果对象。
表4 getresult

参数名称

参数类型

描述

status

int

参数解释：

http状态码。

取值范围：

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

默认取值：

无

reason

str

参数解释：

http文本描述。

默认取值：

无

errorcode

str

参数解释：

obs服务端错误码，当status参数小于300时为空。

默认取值：

无

errormessage

str

参数解释：

obs服务端错误描述，当status参数小于300时为空。

默认取值：

无

requestid

str

参数解释：

obs服务端返回的请求id。

默认取值：

无

indicator

str

参数解释：

obs服务端返回的错误定位码。

默认取值：

无

hostid

str

参数解释：

请求的服务端id，当status参数小于300时为空。

默认取值：

无

resource

str

参数解释：

发生错误时相关的桶或对象，当status参数小于300时为空。

默认取值：

无

header

list

参数解释：

响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。

默认取值：

无

body

object

参数解释：

操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“”章节和“”章节的详细描述。

默认取值：

无
表5 getresult.body

getresult.body类型

说明

getobjectmetadataresponse

参数解释：

获取对象元数据响应结果。详见getobjectmetadataresponse。
表6 getobjectmetadataresponse

参数名称

参数类型

描述

storageclass

str

参数解释：

对象的存储类型。

取值范围：

  • 当对象存储类型是标准存储时，该值为空。
  • 可选择的存储类型参见存储类型。

默认取值：

无

accesscontorlalloworigin

str

参数解释：

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

约束限制：

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

默认取值：

无

accesscontorlallowheaders

str

参数解释：

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

约束限制：

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

默认取值：

无

accesscontorlallowmethods

str

参数解释：

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

取值范围：

支持以下http方法：

  • get
  • put
  • head
  • post
  • delete

默认取值：

无

accesscontorlexposeheaders

str

参数解释：

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

约束限制：

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

默认取值：

无

accesscontorlmaxage

int

参数解释：

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

约束限制：

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

取值范围：

大于等于0的整型数，单位：秒。

默认取值：

100，单位：秒。

contentlength

int

参数解释：

对象数据的长度。

取值范围：

0~48.8tb，单位：字节。

默认取值：

无

contenttype

str

参数解释：

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

取值范围：

常见的contenttype（mime）列表参见。

默认取值：

无

lastmodified

str

参数解释：

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

约束限制：

日期格式为gmt的格式。 例如：wed, 25 mar 2020 02:39:52 gmt。

默认取值：

无

etag

str

参数解释：

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

约束限制：

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

取值范围：

长度为32的字符串。

默认取值：

无

versionid

str

参数解释：

对象的版本号。

取值范围：

长度为32的字符串。

默认取值：

无

restore

str

参数解释：

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

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

约束限制：

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

默认取值：

无

expiration

str

参数解释：

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

默认取值：

无

ssekms

str

参数解释：

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

取值范围：

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

默认取值：

无

ssekmskey

str

参数解释：

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

取值范围：

有效值支持两种格式：

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

其中：

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

默认取值：

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

ssec

str

参数解释：

sse-c方式的算法。

取值范围：

aes256，即高级加密标准（advanced encryption standard，aes）。

默认取值：

无

sseckeymd5

str

参数解释：

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

约束限制：

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

默认取值：

无

websiteredirectlocation

str

参数解释：

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

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

websiteredirectlocation:/anotherpage.html

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

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

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

约束限制：

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

默认取值：

无

isappendable

bool

参数解释：

对象是否可被追加上传。

取值范围：

true：可追加上传

false：不可追加上传

默认取值：

无

nextposition

int

参数解释：

下次追加上传的位置。

取值范围：

0~对象长度，单位：字节。

默认取值：

无
表7 storageclass

参数名称

参数类型

描述

standard

标准存储

参数解释：

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

warm

低频访问存储

参数解释：

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

cold

归档存储

参数解释：

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

deep_archive

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

参数解释：

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

自定义元数据可以到响应的头域中获取。

代码样例

本示例用于获取examplebucket桶里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
 
from obs import obsclient
import os
import traceback
# 推荐通过环境变量获取aksk，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
# 您可以登录访问管理控制台获取访问密钥ak/sk，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
ak = os.getenv("accesskeyid")
sk = os.getenv("secretaccesskey")
# 【可选】如果使用临时aksk和securitytoken访问obs，则同样推荐通过环境变量获取
# security_token = os.getenv("securitytoken")
# server填写bucket对应的endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写
server = "https://obs.cn-north-4.myhuaweicloud.com"
# 创建obsclient实例
# 如果使用临时aksk和securitytoken访问obs，需要在创建实例时通过security_token参数指定securitytoken值
obsclient = obsclient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucketname = "examplebucket"
    objectkey = "objectname"
    # 获取对象元数据
    resp = obsclient.getobjectmetadata(bucketname, objectkey)
    # 返回码为2xx时，接口调用成功，否则接口调用失败
    if resp.status < 300:
        print('get object metadata succeeded')
        print('requestid:', resp.requestid)
        print('etag:', resp.body.etag)
        print('lastmodified:', resp.body.lastmodified)
        print('contenttype:', resp.body.contenttype)
        print('contentlength:', resp.body.contentlength)
    else:
        print('get object metadata failed')
        print('requestid:', resp.requestid)
        print('status:', resp.status)
        print('reason:', resp.reason)
except:
    print('get object metadata failed')
    print(traceback.format_exc())

相关链接

  • 关于获取对象元数据的api说明，请参见获取对象元数据。
  • 更多关于获取对象元数据的示例代码，请参见。
  • 获取对象元数据过程中返回的错误码含义、问题原因及处理措施可参考obs错误码。
父主题：

相关文档

网站地图