文档首页> 对象存储服务 OBS> Python> 桶相关接口(Python SDK)> 获取桶元数据(Python SDK)
更新时间：2024-06-19 GMT+08:00
查看PDF
分享

获取桶元数据(Python SDK)

功能介绍

调用获取桶元数据接口，可获取指定桶的相关信息，包括指定桶的存储类型、区域位置、跨域资源共享（CORS）规则、冗余策略等信息。

接口约束

  • 您必须是桶拥有者或拥有获取桶元数据的权限，才能获取桶元数据。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:HeadBucket权限，如果使用桶策略则需授予HeadBucket权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
  • OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

方法定义

ObsClient.getBucketMetadata(bucketName, origin, requestHeaders)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

桶名。

约束限制：

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

默认取值：

无

origin

str

可选

参数解释：

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

约束限制：

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

默认取值：

无

requestHeaders

str

可选

参数解释：

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

约束限制：

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

默认取值：

无

返回结果说明

表2 返回结果

类型

说明

GetResult

参数解释：

SDK公共结果对象。
表3 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时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值：

无
表4 GetResult.body

GetResult.body类型

说明

GetBucketMetadataResponse

参数解释：

获取桶元数据响应结果。
表5 GetBucketMetadataResponse

参数名称

参数类型

描述

location

str

参数解释：

桶所在的区域。

约束限制：

该参数定义了桶将会被创建在哪个区域，如果使用的终端节点是obs.myhuaweicloud.com，可以不携带此参数；如果使用的终端节点不是obs.myhuaweicloud.com，则必须携带此参数。

取值范围：

当前有效的OBS区域和终端节点的更多信息，请参考地区和终端节点。终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以向企业管理员获取区域和终端节点信息。

默认取值：

终端节点为obs.myhuaweicloud.com且用户未设定区域时，默认为华北-北京一（cn-north-1）。

storageClass

str

参数解释：

桶的存储类型，详情参见StorageClass。

默认取值：

无

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，单位：秒

obsVersion

str

参数解释：

桶所在的OBS服务版本号。

取值范围：

  • “3.0”表示最新版本的桶。
  • “--”表示老版本的桶。

默认取值：

无

availableZone

str

参数解释：

创桶时可指定的数据冗余类型，即AZ类型。

约束限制：

归档存储不支持多AZ。如果桶所在区域不支持多AZ存储，则该桶的存储类型默认为单AZ。

取值范围：

如果桶配置为多AZ，则返回值为"3az"。如果桶配置为单AZ，则返回值为None。

默认取值：

无

epid

str

参数解释：

创桶时可指定的企业项目ID，开通企业项目的用户可以从企业项目服务获取。

约束限制：

Epid格式为uuid，未开通企业项目的用户可以不带该头域。

示例：9892d768-2d13-450f-aac7-ed0e44c2585f

取值范围：

获取方式参见如何获取企业项目ID 。

默认取值：

无
表6 StorageClass

参数名称

参数类型

描述

STANDARD

标准存储

参数解释：

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

WARM

低频访问存储

参数解释：

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

COLD

归档存储

参数解释：

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

代码样例

本示例用于获取名为examplebucke桶的元数据信息，指定的跨域请求origin为"http://www.a.com"，http头域为“x-obs-header”。 
 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
 
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"
    #预请求指定的跨域请求Origin（通常为域名）
    origin='http://www.a.com'
    #跨域请求可以使用的HTTP头域
    requestHeaders='x-obs-header'
    #获取桶的元数据
    resp = obsClient.getBucketMetadata(bucketName,origin,requestHeaders)
    # 返回码为2xx时，接口调用成功，否则接口调用失败
    if resp.status < 300:
        print('Get Bucket Metadata Succeeded')
        print('requestId:', resp.requestId)
        print('storageClass:', resp.body.storageClass)
        print('accessContorlAllowOrigin:', resp.body.accessContorlAllowOrigin)
        print('accessContorlMaxAge:', resp.body.accessContorlMaxAge)
        print('accessContorlExposeHeaders:', resp.body.accessContorlExposeHeaders)
        print('accessContorlAllowMethods:', resp.body.accessContorlAllowMethods)
        print('accessContorlAllowHeaders:', resp.body.accessContorlAllowHeaders)
    else:
        print('Get Bucket Metadata Failed')
        print('requestId:', resp.requestId)
        print('status:', resp.status)
except:
    print('Get Bucket Metadata Failed')
    print(traceback.format_exc())

相关链接

分享：

    相关文档

    相关产品