对象存储服务 OBS-设置桶清单:请求消息元素

时间:2024-10-21 15:06:42

请求消息元素

在此请求中,需要在请求的消息体中配置桶的清单。清单的配置信息以XML格式上传。具体的配置元素如表2

表2 桶的清单配置元素

名称

描述

是否必选

InventoryConfiguration

清单配置。

类型:Container

父节点:无

子节点:Id、IsEnabled、Filter、Destination、Schedule、IncludedObjectVersions以及OptionalFields

Id

清单配置的id,必须和请求参数中的清单配置id一致。

类型:String

规格:最长64字节

默认值:无

有效字符:"a-z"、"A-Z"、"0-9"、"-"、"_"和"."

父节点:InventoryConfiguration

IsEnabled

规则是否启用,如果设置为true,则生成清单,反之不生成。

类型:Boolean

有效值:true、false

父节点:InventoryConfiguration

Filter

清单过滤器配置,清单只包含符合过滤器规则的对象(只支持按对象名前缀进行过滤),如果没有配置过滤器,则包含所有对象。

类型:Container

父节点:InventoryConfiguration

子节点:Prefix

Prefix

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

类型:String

父节点:Filter

Schedule

清单文件的生成周期。

类型:Container

父节点:InventoryConfiguration

子节点:Frequency

Frequency

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

类型:String

父节点:Schedule

有效值:Daily、Weekly

Destination

清单的目标配置。

类型:Container

父节点:InventoryConfiguration

Format

生成的清单文件的格式,现只支持 CS V格式。

类型:String

父节点:Destination

有效值:CSV

Bucket

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

类型:String

父节点:Destination

Prefix

生成的清单文件对象名会以此前缀开头,如果不配置前缀,则生成的清单文件对象名默认以BucketInventory开头。

类型:String

父节点:Destination

IncludedObjectVersions

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

  • 如果设置为All,清单会包含对象所有的版本,清单中会增加版本相关的字段:VersionId、IsLatest、和DeleteMarker。
  • 如果设置为Current,则清单文件中只会列出当前版本信息,不会出现版本相关字段。

类型:String

父节点:InventoryConfiguration

有效值:All、Current

OptionalFields

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

类型:Container

父节点:InventoryConfiguration

子节点:Field

Field

可选字段类型,OptionalFields可以包含多个Field元素。

类型:String

父节点:OptionalFields

有效值:Size、LastModifiedDate、StorageClass、ETag、IsMultipartUploaded、ReplicationStatus、EncryptionStatus。

support.huaweicloud.com/api-obs/obs_04_0055.html