华为云计算 云知识 获取桶清单GetBucketInventory
获取桶清单GetBucketInventory

 

接口说明

OBS使用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。

id
 
string query

需要获取的清单配置的id。 有效字符:"a-z"、"A-Z"、"0-9"、"-"、"_"和"."

返回参数
返回码: 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创建来唯一确定本次请求的值,可以通过该值来定位问题。

名称 类型 必选 描述
InventoryConfiguration
 
SetBucketInventoryRequestBody object

清单配置

200 InventoryConfiguration
名称 类型 必选 描述
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 InventoryConfiguration.Filter
名称 类型 必选 描述
Prefix
 
string

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

200 InventoryConfiguration.Destination
名称 类型 必选 描述
Format
 
string

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

Bucket
 
string

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

Prefix
 
string

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

200 InventoryConfiguration.Schedule
名称 类型 必选 描述
Frequency
 
string

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

返回码: 400

请求失败响应消息。

名称 类型 必选 描述
Code
 
string

错误响应消息体XML中错误响应对应的HTTP消息返回码,具体的错误码请参见错误码-表2

Message
 
string

错误响应消息体XML中具体错误更全面、详细的英文解释,具体的错误消息请参见错误码-表2

RequestId
 
string

本次错误请求的请求ID,用于错误定位。

HostId
 
string

返回该消息的服务端ID。

Resource
 
string

该错误相关的桶或对象资源。

返回码: 404

请求失败响应消息。 除了公共的错误码外,此接口还会返回一些其他的错误码。下面列出本接口的一些常见错误,以及可能原因。

错误码 描述 HTTP状态码
NoSuchInventoryConfiguration 没有指定Id对应的清单配置。 404 Not Found
名称 类型 必选 描述
Code
 
string

错误响应消息体XML中错误响应对应的HTTP消息返回码,具体的错误码请参见错误码-表2

Message
 
string

错误响应消息体XML中具体错误更全面、详细的英文解释,具体的错误消息请参见错误码-表2

RequestId
 
string

本次错误请求的请求ID,用于错误定位。

HostId
 
string

返回该消息的服务端ID。

Resource
 
string

该错误相关的桶或对象资源。

请求示例
示例 1
 
"/?inventory&id=id1"
 
"GET /?inventory&id=id1 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"?> <InventoryConfiguration xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/"> <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>
错误码
请参考 错误码说明

 

上一篇:数据管理服务DAS企业版 下一篇:创建SecretcreateCoreV1NamespacedSecret

对象存储服务 OBS     

对象存储服务(Object Storage Service)是一款稳定、安全、高效、易用的云存储服务,具备标准Restful API接口,可存储任意数量和形式的非结构化数据。