文档首页/ 对象存储服务 OBS/ API参考/ API/ 桶的基础操作/ 获取桶元数据-GetBucketMetadata
更新时间：2025-12-18 GMT+08:00
查看PDF
分享

获取桶元数据-GetBucketMetadata

功能介绍

对桶拥有读权限的用户可以执行查询桶元数据是否存在的操作。

授权信息

您必须是桶拥有者或拥有获取桶元数据的权限，才能调用本接口，建议使用IAM或桶策略进行授权。了解更多OBS授权方式请参见OBS不同权限控制方式的区别。

  • 如果使用IAM授权，那么请在“角色与策略授权”、“身份策略授权”两种IAM授权方式中选择一种，并配置相应权限：
    • 如果使用角色与策略授权（旧版IAM，即IAM v3接口），需具备obs:bucket:HeadBucket权限，授权操作请参见创建IAM自定义策略。
    • 如果使用身份策略授权（新版IAM，即IAM v5接口），如下表所示，需具备obs:bucket:headBucket权限，授权操作请参见创建IAM自定义身份策略。

      授权项

      Action

      访问级别

      Access Level

      资源类型（*为必须）

      Resource Type (*: required)

      条件键

      Condition Key

      别名

      Alias

      依赖的授权项

      Dependencies

      obs:bucket:headBucket

      Read

      bucket *

      -

      -

      -
      • obs:EpochTime
      • obs:SourceIp
      • obs:TlsVersion
      • obs:CustomDomain
  • 如果使用桶策略进行授权，需具备obs:bucket:HeadBucket权限，具体操作请参见自定义创建桶策略。

请求消息样式

1
2
3
4
 
HEAD / HTTP/1.1 
Host: bucketname.obs.cn-north-4.myhuaweicloud.com 
Date: date
Authorization: authorization

请求消息参数

该请求消息中不带消息参数。

请求消息头

该请求使用公共消息头，具体参见表3。

如果想要获取CORS配置信息，则需要使用的消息头如下表1所示。

表1 获取CORS配置的请求消息头

消息头名称

消息头类型

是否必选

描述

Origin

String

是

参数解释：

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

约束限制:

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

取值范围：

符合http协议的该头域的值。

默认取值：

无

Access-Control-Request-Headers

String

否

参数解释：

实际请求可以带的HTTP头域。

约束限制:

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

取值范围：

符合http协议的该头域的值。

默认取值：

无

请求消息元素

该请求消息中不带消息元素。

响应消息样式

1
2
3
 
HTTP/1.1 status_code
x-obs-bucket-location: cn-north-4
Date: date

响应消息头

该请求的响应消息使用公共消息头，具体请参考表1。

除公共响应消息头之外，还可能使用如下表2中的消息头。

表2 附加响应消息头

消息头名称

消息头类型

描述

x-obs-bucket-location

String

参数解释：

桶的区域位置信息。

约束限制：

无

取值范围：

无

默认取值：

无

x-obs-storage-class

String

参数解释：

桶的默认存储类型。

约束限制：

无

取值范围：

  • STANDARD（标准存储）
  • WARM（低频访问存储）
  • COLD（归档存储）
  • DEEP_ARCHIVE（深度归档存储）

默认取值：

无

x-obs-version

String

参数解释：

桶所在的OBS服务版本号。

约束限制：

无

取值范围：

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

默认取值：

无

x-obs-fs-file-interface

String

参数解释：

判断是否为并行文件系统。

约束限制：

不携带此头域表示不属于并行文件系统。

取值范围：

取值包含Enabled（并行文件系统）。

默认取值：

无

x-obs-epid

String

参数解释：

当前桶的企业项目ID，开通企业项目的用户可以从企业项目服务获取。

约束限制:

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

取值范围：

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

默认取值：

无

x-obs-az-redundancy

String

参数解释：

桶的数据冗余存储策略属性，即AZ类型。

取值为3az，表示数据冗余存储在同一区域的多个可用区。

不携带此头域表示为单az存储，仅使用1个可用区存储。

约束限制：

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

取值范围：

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

默认取值：

无

Access-Control-Allow-Origin

String

参数解释：

当桶设置了CORS配置，如果请求的Origin满足服务端的CORS配置，则在响应中包含这个Origin。

约束限制：

无

取值范围：

符合CORS协议的取值范围。

默认取值：

无

Access-Control-Allow-Headers

String

参数解释：

当桶设置了CORS配置，如果请求的headers满足服务端的CORS配置，则在响应中包含这个headers。

约束限制：

无

取值范围：

符合CORS协议的取值范围。

默认取值：

无

Access-Control-Max-Age

Integer

参数解释：

当桶设置了CORS配置，服务端CORS配置中的MaxAgeSeconds。

约束限制：

无

取值范围：

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

默认取值：

3000

Access-Control-Allow-Methods

String

参数解释：

当桶设置了CORS配置，如果请求的Access-Control-Request-Method满足服务端的CORS配置，则在响应中包含这条rule中的Methods。

约束限制：

无

取值范围：

  • GET
  • PUT
  • HEAD
  • POST
  • DELETE

默认取值：

无

Access-Control-Expose-Headers

String

参数解释：

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

约束限制：

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

取值范围：

无

默认取值：

无

x-obs-ies-location

String

参数解释：

当桶是CloudPond的桶时返回此头域，头域值为CloudPond站点的AZ Id。

约束限制：

不携带此头域表示不是CloudPond桶。

取值范围：

无

默认取值：

无

x-obs-edge-location

String

参数解释：

当桶是智能边缘云的桶时返回此头域，头域值为智能边缘云站点的AZ Id。

约束限制：

不携带此头域表示不是IEC桶。

取值范围：

无

默认取值：

无

响应消息元素

该请求的响应中不带有响应元素。

错误响应消息

无特殊错误，所有错误已经包含在表2中。

请求示例：未携带获取CORS配置

1
2
3
4
5
6
 
HEAD / HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Accept: */*
Date: WED, 01 Jul 2015 02:30:25 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:niCQCuGIZpETKIyx1datxHZyYlk=

响应示例：未携带获取CORS配置

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
 
HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: BF260000016439C734E0788404623FA8
Content-Type: application/xml
x-obs-storage-class: STANDARD
x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSxwLpq9Hzf3OnaXr+pI/OPLKdrtiQAF
Date: WED, 01 Jul 2015 02:30:25 GMT
x-obs-bucket-location: cn-north-4
x-obs-version: 3.0
Content-Length: 0

请求示例：桶设置了CORS后，获取桶元数据和CORS配置

1
2
3
4
5
6
7
8
 
HEAD / HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Accept: */*
Date: WED, 01 Jul 2015 02:30:25 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:niCQCuGIZpETKIyx1datxHZyYlk=
Origin:www.example.com
Access-Control-Request-Headers:AllowedHeader_1

响应示例：桶设置了CORS后，获取桶元数据和CORS配置

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
 
HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: BF260000016439C734E0788404623FA8
Content-Type: application/xml
x-obs-storage-class: STANDARD
x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSxwLpq9Hzf3OnaXr+pI/OPLKdrtiQAF
Date: WED, 01 Jul 2015 02:30:25 GMT
x-obs-bucket-location: cn-north-4
Access-Control-Allow-Origin: www.example.com 
Access-Control-Allow-Methods: POST,GET,HEAD,PUT 
Access-Control-Allow-Headers: AllowedHeader_1 
Access-Control-Max-Age: 100 
Access-Control-Expose-Headers: ExposeHeader_1 
x-obs-version: 3.0
Content-Length: 0
父主题： 桶的基础操作

相关文档