華為云計(jì)算 云知識(shí) 列舉桶清單ListBucketInventory
列舉桶清單ListBucketInventory

 

接口說(shuō)明

OBS使用不帶清單id的GET操作來(lái)獲取指定桶的所有清單配置,獲取到的清單配置一次性返回,不分頁(yè)。

要正確執(zhí)行此操作,需要確保執(zhí)行者有GetBucketInventoryConfiguration權(quán)限。缺省情況下只有桶的所有者可以執(zhí)行此操作,也可以通過(guò)設(shè)置桶策略或用戶(hù)策略授權(quán)給其他用戶(hù)。

有關(guān)權(quán)限控制的更多信息請(qǐng)參考《 對(duì)象存儲(chǔ)服務(wù) 權(quán)限配置指南》的OBS權(quán)限控制概述章節(jié)。

URL
GET  https://obs.cn-north-4.myhuaweicloud.com/ 
請(qǐng)求參數(shù)
名稱(chēng) 類(lèi)型 IN 必選 描述
Authorization
 
string header

請(qǐng)求消息中可帶的簽名信息。

Date
 
string header

請(qǐng)求發(fā)起端的日期和時(shí)間,例如:Wed, 27 Jun 2018 13:39:15 +0000。 默認(rèn)值:無(wú)。 條件:如果消息頭中帶了x-obs-date字段,則可以不帶該字段,其他情況下必選。

bucket_name
 
string query

請(qǐng)求的桶名稱(chēng)。

inventory
 
string query

inventory表示請(qǐng)求桶清單API。

返回參數(shù)
返回碼: 200

請(qǐng)求成功響應(yīng)消息。

名稱(chēng) 類(lèi)型 必選 描述
Content-Length
 
string

響應(yīng)消息體的字節(jié)長(zhǎng)度。

Connection
 
string

指明與服務(wù)器的連接是長(zhǎng)連接還是短連接。

Date
 
string

OBS系統(tǒng)響應(yīng)的時(shí)間。

ETag
 
string

對(duì)象的base64編碼的128位MD5摘要。ETag是對(duì)象內(nèi)容的唯一標(biāo)識(shí),可以通過(guò)該值識(shí)別對(duì)象內(nèi)容是否有變化。比如上傳對(duì)象時(shí)ETag為A,下載對(duì)象時(shí)ETag為B,則說(shuō)明對(duì)象內(nèi)容發(fā)生了變化。實(shí)際的ETag是對(duì)象的哈希值。ETag只反映變化的內(nèi)容,而不是其元數(shù)據(jù)。上傳的對(duì)象或拷貝操作創(chuàng)建的對(duì)象,通過(guò)MD5加密后都有唯一的ETag。如果通過(guò)多段上傳對(duì)象,則無(wú)論加密方法如何,MD5會(huì)拆分ETag,此類(lèi)情況ETag就不是MD5的摘要。

x-obs-id-2
 
string

幫助定位問(wèn)題的特殊符號(hào)。

x-obs-request-id
 
string

由OBS創(chuàng)建來(lái)唯一確定本次請(qǐng)求的值,可以通過(guò)該值來(lái)定位問(wèn)題。

返回碼: 200
名稱(chēng) 類(lèi)型 必選 描述
[數(shù)組元素]
 
Array of SetBucketInventoryRequestBody objects

桶清單配置列表。

200 [數(shù)組元素]
名稱(chēng) 類(lèi)型 必選 描述
Id
 
string

清單配置的id,必須和請(qǐng)求參數(shù)中的清單配置id一致。 有效字符:"a-z"、"A-Z"、"0-9"、"-"、"_"和"."

IsEnabled
 
boolean

規(guī)則是否啟用,如果設(shè)置為true,則生成清單,反之不生成。

Filter
 
Filter object

清單過(guò)濾器配置,清單只包含符合過(guò)濾器規(guī)則的對(duì)象(只支持按對(duì)象名前綴進(jìn)行過(guò)濾),如果沒(méi)有配置過(guò)濾器,則包含所有對(duì)象。

Destination
 
Destination object

清單的目標(biāo)配置。

Schedule
 
Schedule object

清單文件的生成周期。

IncludedObjectVersions
 
string

清單文件中包含對(duì)象的多版本配置。 如果設(shè)置為All,清單會(huì)包含對(duì)象所有的版本,清單中會(huì)增加版本相關(guān)的字段:VersionId、IsLatest、和DeleteMarker。 如果設(shè)置為Current,則清單文件中只會(huì)列出當(dāng)前版本信息,不會(huì)出現(xiàn)版本相關(guān)字段。

OptionalFields
 
Array of strings

在此選項(xiàng)中可以添加一些額外的對(duì)象元數(shù)據(jù)字段,生成的清單文件中會(huì)包含OptionalFields中配置的字段。

200 [數(shù)組元素].Filter
名稱(chēng) 類(lèi)型 必選 描述
Prefix
 
string

前綴過(guò)濾條件,清單文件中只生成以此前綴開(kāi)頭的對(duì)象列表。

200 [數(shù)組元素].Destination
名稱(chēng) 類(lèi)型 必選 描述
Format
 
string

生成的清單文件的格式,現(xiàn)只支持CSV格式。

Bucket
 
string

存放清單文件的目標(biāo)桶的桶名。

Prefix
 
string

生成的清單文件對(duì)象名會(huì)以此前綴開(kāi)頭,如果不配置前綴,則生成的清單文件對(duì)象名默認(rèn)以BucketInventory開(kāi)頭。

200 [數(shù)組元素].Schedule
名稱(chēng) 類(lèi)型 必選 描述
Frequency
 
string

清單文件的生成周期,只支持按天和按周生成清單,第一次配置完桶清單,任務(wù)會(huì)在一個(gè)小時(shí)內(nèi)啟動(dòng),之后每隔一個(gè)周期啟動(dòng)一次。

返回碼: 400

請(qǐng)求失敗響應(yīng)消息。

名稱(chēng) 類(lèi)型 必選 描述
Code
 
string

錯(cuò)誤響應(yīng)消息體XML中錯(cuò)誤響應(yīng)對(duì)應(yīng)的HTTP消息返回碼,具體的錯(cuò)誤碼請(qǐng)參見(jiàn)錯(cuò)誤碼-表2。

Message
 
string

錯(cuò)誤響應(yīng)消息體XML中具體錯(cuò)誤更全面、詳細(xì)的英文解釋,具體的錯(cuò)誤消息請(qǐng)參見(jiàn)錯(cuò)誤碼-表2。

RequestId
 
string

本次錯(cuò)誤請(qǐng)求的請(qǐng)求ID,用于錯(cuò)誤定位。

HostId
 
string

返回該消息的服務(wù)端ID。

Resource
 
string

該錯(cuò)誤相關(guān)的桶或?qū)ο筚Y源。

請(qǐng)求示例
示例 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

請(qǐng)求成功響應(yīng)消息。

示例 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>
錯(cuò)誤碼
請(qǐng)參考 錯(cuò)誤碼說(shuō)明。