列举桶清单ListBucketInventory_桶的高级配置

华为云计算云知识列举桶清单ListBucketInventory

普惠上云 2核2G2M云服务器

38元/年

云服务器新品 X实例-4核8G5M

288元/年

新品尝鲜云耀数据库HRDS

免费试用

网站搭建买3年送2年

1元/天

列举桶清单ListBucketInventory

时间: 2023-08-16 15:03:27

API网关云服务器云主机云计算弹性伸缩

猜你想看：

华为云耀L实例实时语音识别云服务器配置 CDN是什么意思视频点播加速什么是云桌面

接口说明

OBS使用不带清单id的GET操作来获取指定桶的所有清单配置,获取到的清单配置一次性返回,不分页。

要正确执行此操作,需要确保执行者有GetBucketInventoryConfiguration权限。缺省情况下只有桶的所有者可以执行此操作,也可以通过设置桶策略或用户策略授权给其他用户。

有关权限控制的更多信息请参考《对象存储服务权限配置指南》的OBS权限控制概述章节。

URL

GET https://obs.cn-north-4.myhuaweicloud.com/

请求参数

名称	类型	IN	必选	描述
Authorization	string	header	是	请求消息中可带的签名信息。
Date	string	header	否	请求发起端的日期和时间,例如:Wed, 27 Jun 2018 13:39:15 +0000。默认值:无。条件:如果消息头中带了x-obs-date字段,则可以不带该字段,其他情况下必选。
bucket_name	string	query	是	请求的桶名称。
inventory	string	query	是	inventory表示请求桶清单API。

返回参数

返回码: 200

请求成功响应消息。

名称	类型	必选	描述
Content-Length	string	否	响应消息体的字节长度。
Connection	string	否	指明与服务器的连接是长连接还是短连接。
Date	string	否	OBS系统响应的时间。
ETag	string	否	对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识,可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A,下载对象时ETag为B,则说明对象内容发生了变化。实际的ETag是对象的哈希值。ETag只反映变化的内容,而不是其元数据。上传的对象或拷贝操作创建的对象,通过MD5加密后都有唯一的ETag。如果通过多段上传对象,则无论加密方法如何,MD5会拆分ETag,此类情况ETag就不是MD5的摘要。
x-obs-id-2	string	否	帮助定位问题的特殊符号。
x-obs-request-id	string	否	由OBS创建来唯一确定本次请求的值,可以通过该值来定位问题。

返回码: 200

名称	类型	必选	描述
[数组元素]	Array of SetBucketInventoryRequestBody objects	否	桶清单配置列表。

200 [数组元素]

名称	类型	必选	描述
Id	string	是	清单配置的id,必须和请求参数中的清单配置id一致。有效字符:"a-z"、"A-Z"、"0-9"、"-"、"_"和"."
IsEnabled	boolean	是	规则是否启用,如果设置为true,则生成清单,反之不生成。
Filter	Filter object	否	清单过滤器配置,清单只包含符合过滤器规则的对象(只支持按对象名前缀进行过滤),如果没有配置过滤器,则包含所有对象。
Destination	Destination object	是	清单的目标配置。
Schedule	Schedule object	是	清单文件的生成周期。
IncludedObjectVersions	string	是	清单文件中包含对象的多版本配置。如果设置为All,清单会包含对象所有的版本,清单中会增加版本相关的字段:VersionId、IsLatest、和DeleteMarker。如果设置为Current,则清单文件中只会列出当前版本信息,不会出现版本相关字段。
OptionalFields	Array of strings	否	在此选项中可以添加一些额外的对象元数据字段,生成的清单文件中会包含OptionalFields中配置的字段。

200 [数组元素].Filter

名称	类型	必选	描述
Prefix	string	否	前缀过滤条件,清单文件中只生成以此前缀开头的对象列表。

200 [数组元素].Destination

名称	类型	必选	描述
Format	string	是	生成的清单文件的格式,现只支持CSV格式。
Bucket	string	是	存放清单文件的目标桶的桶名。
Prefix	string	否	生成的清单文件对象名会以此前缀开头,如果不配置前缀,则生成的清单文件对象名默认以BucketInventory开头。

200 [数组元素].Schedule

名称	类型	必选	描述
Frequency	string	是	清单文件的生成周期,只支持按天和按周生成清单,第一次配置完桶清单,任务会在一个小时内启动,之后每隔一个周期启动一次。

返回码: 400

请求失败响应消息。

名称	类型	必选	描述
Code	string	否	错误响应消息体XML中错误响应对应的HTTP消息返回码,具体的错误码请参见错误码-表2。
Message	string	否	错误响应消息体XML中具体错误更全面、详细的英文解释,具体的错误消息请参见错误码-表2。
RequestId	string	否	本次错误请求的请求ID,用于错误定位。
HostId	string	否	返回该消息的服务端ID。
Resource	string	否	该错误相关的桶或对象资源。

请求示例

示例 1

"/?inventory"

"GET /?inventory HTTP/1.1\nUser-Agent: curl/7.29.0\nHost: examplebucket.obs.cn-north-4.myhuaweicloud.com\nAccept: */*\nDate: Tue, 08 Jan 2019 09:32:24 +0000\nAuthorization: OBS UDS IAM STUBTEST000001:ySWncC9M08jNsyXdJLSMJkpi7XM=\n"

返回示例

返回码：200

请求成功响应消息。

示例 1

HTTP/1.1 200 OK Server: OBS x-obs-request-id: 000001682CB4C2EE6808A0D8DF9F3D00 x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAA BCS Bjn5O7Jv9CqvUMO0BenehRdil1n8rR Content-Type: application/xml Date: Tue, 08 Jan 2019 09:04:30 GMT Content-Length: 626 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ListInventoryConfiguration xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/"> <InventoryConfiguration> <Id>id1</Id> <IsEnabled>true</IsEnabled> <Destination> <Format>CSV</Format> <Bucket>bucket</Bucket> <Prefix>prefix</Prefix> </Destination> <Schedule> <Frequency>Daily</Frequency> </Schedule> <IncludedObjectVersions>Current</IncludedObjectVersions> <OptionalFields> <Field>Size</Field> <Field>LastModifiedDate</Field> <Field>ETag</Field> <Field>StorageClass</Field> <Field>IsMultipartUploaded</Field> <Field>ReplicationStatus</Field> <Field>EncryptionStatus</Field> </OptionalFields> </InventoryConfiguration> </ListInventoryConfiguration>

错误码

请参考错误码说明。