InventoryConfiguration

configurationId

String

必选

参数解释：

桶清单配置规则的id。

约束限制：

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

取值范围：

长度最长为64的字符串。

默认取值：

无

isEnabled

boolean

必选

参数解释：

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

取值范围：

true：生成清单文件。

false：不生成清单文件。

默认取值：

true

objectPrefix

String

可选

参数解释：

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

取值范围：

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

默认取值：

无

frequency

String

必选

参数解释：

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

取值范围：

Daily：按天生成清单

Weekly：按周生成清单

默认取值：

无

inventoryFormat

String

必选

参数解释：

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

取值范围：

CSV

默认取值：

无

destinationBucket

String

必选

参数解释：

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

约束限制：

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

默认取值：

无

inventoryPrefix

String

可选

参数解释：

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

取值范围：

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

默认取值：

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

includedObjectVersions

String

必选

参数解释：

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

取值范围：

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

默认取值：

无

optionalFields

ArrayList<String>

可选

参数解释：

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

取值范围：

Size：对象大小。

LastModifiedDate：对象最后修改时间。

StorageClass：对象的存储类别。

ETag：对象的ETag值。

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

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

EncryptionStatus：对象的加密状态。

BucketKeyStatus：桶密钥状态。

UserMeta：用户自定义元数据。

CRC64：对象的 CRC64 校验值。

ObjectType：对象类型。

默认取值：

无

filter

表2

可选

参数解释：

桶清单的过滤条件，支持按对象名前缀、是否最新版本、是否删除标记进行过滤，并支持通过 And 操作符组合多条件。

约束限制：

filter 与 objectPrefix 互斥，设置 filter 时优先使用 filter，未设置 filter 时回退到 objectPrefix。

取值范围：

详见表2。

默认取值：

无

prefix

String

可选

参数解释：

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

取值范围：

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

默认取值：

空字符串，即不按前缀过滤。