文档首页/ 对象存储服务 OBS/ SDK参考/ Python/ 桶相关接口(Python SDK)/ 桶清单(Python SDK)/ 设置桶清单规则(Python SDK)
更新时间：2026-07-13 GMT+08:00
查看PDF
分享

设置桶清单规则(Python SDK)

功能介绍

桶清单功能可以定期生成桶内对象的相关信息，保存在CSV格式的文件中，并上传到您指定的桶中，方便您管理桶内对象。目标桶和源桶可以是同一个桶。指定的对象内容包括对象版本、大小、上次修改时间、存储类别、标签、加密状态等。

支持对桶清单加密，加密方式为SSE-KMS方式。

接口约束

  • 您必须是桶拥有者或者拥有设置桶清单权限，才能设置桶清单。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketInventoryConfiguration权限，如果使用桶策略则需授予PutBucketInventoryConfiguration权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
  • OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。
  • 桶版本限制：
    • 只有OBS 3.0的桶支持配置清单，目标桶无OBS版本限制。
  • 清单数量限制：
    • 一个桶最多支持10条桶清单。
  • 源桶和目标桶限制：
    • 桶清单配置的源桶和目标桶必须归属同一个账号。
    • 桶清单配置的源桶和目标桶必须归属同一个区域。
    • 桶清单中配置的目标桶不能开启桶默认加密。
  • 功能限制：
    • 只支持生成CSV格式的清单文件。
    • 桶清单筛选条件目前仅支持设置为所有对象或指定前缀的对象。
    • 同一个桶中多条清单规则的筛选条件不能彼此包含：
      • 如果已经存在针对桶中所有对象的规则，则无法再创建按对象名前缀筛选的规则。如需创建，要先删除针对所有对象的规则。
      • 如果已经存在按对象名前缀筛选的规则，则无法再创建针对桶中所有对象的规则。如需创建，要先删除所有按对象名前缀筛选的规则。
      • 如果已经存在某个按对象名前缀筛选的规则（如前缀ab），则无法再创建与其存在包含或被包含关系的规则（如前缀a或前缀abc）。如需创建，要先删除存在包含或被包含关系的规则。
    • 桶清单加密方式目前只支持SSE-KMS。
  • 权限限制：
    • 清单文件使用OBS系统用户上传到目标桶，目标桶必须给OBS系统用户写权限。
  • 其他：
    • 暂不对桶清单功能收费，桶清单生成后只按照存量计费。

方法定义

ObsClient.putBucketInventory(bucketName, inventoryId, inventoryConfiguration, extensionHeaders)

请求参数说明

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

桶名。

约束限制：

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

默认取值：

无

inventoryId

str

必选

参数解释：

桶清单配置规则的id。

约束限制：

必须由以下字符组成"a-z"、"A-Z"、"0-9"、"-"、"_"和"."。

取值范围：

长度最长为64的字符串。

默认取值：

无

inventoryConfiguration

InventoryConfiguration

必选

参数解释：

桶清单配置规则，详见InventoryConfiguration。

extensionHeaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

参考自定义头域。

默认取值：

无
表1 InventoryConfiguration

参数名称

参数类型

是否必选

描述

inventoryId

str

必选

参数解释：

桶清单配置规则的id。

约束限制：

必须由以下字符组成"a-z"、"A-Z"、"0-9"、"-"、"_"和"."。

取值范围：

长度最长为64的字符串。

默认取值：

无

isEnabled

bool

必选

参数解释：

桶清单配置规则是否启用。

取值范围：

True：生成清单文件。

False：不生成清单文件。

默认取值：

True

objectVersion

str

必选

参数解释：

清单文件中包含对象的多版本配置。

取值范围：

  • All：清单会包含对象所有的版本，清单中会增加版本相关的字段：VersionId、IsLatest和DeleteMarker。
  • Current：清单文件中只会列出当前版本信息，不会出现版本相关字段。

默认取值：

无

filter

表2 InventoryFilter

可选

参数解释：

清单过滤器配置，清单只包含符合过滤器规则的对象（只支持按对象名前缀进行过滤），如果没有配置过滤器，则包含所有对象。详见表2 InventoryFilter

frequency

str

必选

参数解释：

清单文件的生成周期，只支持按天和按周生成清单，第一次配置完桶清单，任务会在一个小时内启动，之后每隔一个周期启动一次。

取值范围：

Daily：按天生成清单

Weekly：按周生成清单

默认取值：

无

destination

表3 InventoryDestination

必选

参数解释：

清单的目标配置。详见表3 InventoryDestination

optionalFields

list

可选

参数解释：

在此选项中可以添加一些额外的对象元数据字段，生成的清单文件中会包含optionalFields中配置的字段。

取值范围：

Size：对象大小。

LastModifiedDate：对象最后修改时间。

StorageClass：对象的存储类别。

ETag：对象的ETag值。

IsMultipartUploaded：对象是否为多段上传。

ReplicationStatus：对象的跨区域复制状态。

EncryptionStatus：对象的加密状态。

默认取值：

无
表2 InventoryFilter

参数名称

参数类型

是否必选

描述

prefix

str

可选

参数解释：

前缀过滤条件，清单文件中只生成以此前缀开头的对象列表。

取值范围：

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

默认取值：

无
表3 InventoryDestination

参数名称

参数类型

是否必选

描述

bucket

str

必选

参数解释：

存放清单文件的目标桶的桶名。

约束限制：

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

默认取值：

无

prefix

str

可选

参数解释：

生成的清单文件对象名会以此前缀开头。

取值范围：

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

默认取值：

BucketInventory，即如果不配置前缀，则生成的清单文件对象名默认以"BucketInventory"字符串为前缀开头。

format

str

必选

参数解释：

生成的清单文件的格式，现只支持CSV格式。

取值范围：

CSV

默认取值：

无

返回结果说明

类型

说明

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

默认取值：

无

代码样例

本示例用于设置examplebucket桶清单配置。

 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
49
50
51
52
53
 
from obs import ObsClient, InventoryDestination, InventoryFilter, InventoryConfiguration
import os
import traceback

# 推荐通过环境变量获取AK/SK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
# 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# 如需使用临时AK/SK和SecurityToken访问OBS，则同样推荐通过环境变量获取
# security_token = os.getenv("SecurityToken")
# server填写Bucket对应的Endpoint，这里以华北-北京四为例，其他地区请按实际情况填写
server = "https://obs.cn-north-4.myhuaweicloud.com"
# 创建obsClient实例
# 如果使用临时AK/SK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucketName = 'examplebucket'
    # 桶清单配置规则的id
    inventory_id = 'example-id'
    # 清单的目标配置
    destination = InventoryDestination(
        bucket=bucketName,
        format='CSV',
        prefix='inventory_test/'
    )
    # 桶清单配置规则
    config = InventoryConfiguration(
        inventoryId=inventory_id,
        # 桶清单配置规则是否启用
        isEnabled=True,
        # 清单文件中包含对象的多版本配置
        objectVersion='All',
        # 清单文件的生成周期
        frequency='Daily',
        destination=destination,
        # 清单过滤器配置，清单只包含符合过滤器规则的对象（只支持按对象名前缀进行过滤），如果没有配置过滤器，则包含所有对象
        filter=InventoryFilter(prefix='test/')
    )
    # 设置桶清单
    resp = obsClient.putBucketInventory(bucketName, inventory_id, config)

    # 返回码为2xx时，接口调用成功，否则接口调用失败
    if resp.status < 300:
        print('Put Bucket Inventory Succeeded')
        print('requestId:', resp.requestId)
    else:
        print('Put Bucket Inventory Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except Exception:
    print('Put Bucket Inventory Failed')
    print(traceback.format_exc())
父主题： 桶清单(Python SDK)

相关文档