OBS使用GET操作來獲取指定桶的某個清單配置。
要正確執(zhí)行此操作,需要確保執(zhí)行者有GetBucketInventoryConfiguration權(quán)限。桶擁有者默認(rèn)具有此權(quán)限,并且可以將此權(quán)限授予其他人。
有關(guān)權(quán)限控制的更多信息請參考《 對象存儲服務(wù) 權(quán)限配置指南》的OBS權(quán)限控制概述章節(jié)。
| 名稱 | 類型 | IN | 必選 | 描述 |
|---|---|---|---|---|
|
Authorization
|
string | header | 是 |
請求消息中可帶的簽名信息。 |
|
Date
|
string | header | 否 |
請求發(fā)起端的日期和時間,例如:Wed, 27 Jun 2018 13:39:15 +0000。 默認(rèn)值:無。 條件:如果消息頭中帶了x-obs-date字段,則可以不帶該字段,其他情況下必選。 |
|
bucket_name
|
string | query | 是 |
請求的桶名稱。 |
|
inventory
|
string | query | 是 |
inventory表示請求桶清單API。 |
|
id
|
string | query | 是 |
需要獲取的清單配置的id。 有效字符:"a-z"、"A-Z"、"0-9"、"-"、"_"和"." |
請求成功響應(yīng)消息。
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
Content-Length
|
string | 否 |
響應(yīng)消息體的字節(jié)長度。 |
|
Connection
|
string | 否 |
指明與服務(wù)器的連接是長連接還是短連接。 |
|
Date
|
string | 否 |
OBS系統(tǒng)響應(yīng)的時間。 |
|
ETag
|
string | 否 |
對象的base64編碼的128位MD5摘要。ETag是對象內(nèi)容的唯一標(biāo)識,可以通過該值識別對象內(nèi)容是否有變化。比如上傳對象時ETag為A,下載對象時ETag為B,則說明對象內(nèi)容發(fā)生了變化。實際的ETag是對象的哈希值。ETag只反映變化的內(nèi)容,而不是其元數(shù)據(jù)。上傳的對象或拷貝操作創(chuàng)建的對象,通過MD5加密后都有唯一的ETag。如果通過多段上傳對象,則無論加密方法如何,MD5會拆分ETag,此類情況ETag就不是MD5的摘要。 |
|
x-obs-id-2
|
string | 否 |
幫助定位問題的特殊符號。 |
|
x-obs-request-id
|
string | 否 |
由OBS創(chuàng)建來唯一確定本次請求的值,可以通過該值來定位問題。 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
InventoryConfiguration
|
SetBucketInventoryRequestBody object | 否 |
清單配置 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
Id
|
string | 是 |
清單配置的id,必須和請求參數(shù)中的清單配置id一致。 有效字符:"a-z"、"A-Z"、"0-9"、"-"、"_"和"." |
|
IsEnabled
|
boolean | 是 |
規(guī)則是否啟用,如果設(shè)置為true,則生成清單,反之不生成。 |
|
Filter
|
Filter object | 否 |
清單過濾器配置,清單只包含符合過濾器規(guī)則的對象(只支持按對象名前綴進(jìn)行過濾),如果沒有配置過濾器,則包含所有對象。 |
|
Destination
|
Destination object | 是 |
清單的目標(biāo)配置。 |
|
Schedule
|
Schedule object | 是 |
清單文件的生成周期。 |
|
IncludedObjectVersions
|
string | 是 |
清單文件中包含對象的多版本配置。 如果設(shè)置為All,清單會包含對象所有的版本,清單中會增加版本相關(guān)的字段:VersionId、IsLatest、和DeleteMarker。 如果設(shè)置為Current,則清單文件中只會列出當(dāng)前版本信息,不會出現(xiàn)版本相關(guān)字段。 |
|
OptionalFields
|
Array of strings | 否 |
在此選項中可以添加一些額外的對象元數(shù)據(jù)字段,生成的清單文件中會包含OptionalFields中配置的字段。 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
Prefix
|
string | 否 |
前綴過濾條件,清單文件中只生成以此前綴開頭的對象列表。 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
Format
|
string | 是 |
生成的清單文件的格式,現(xiàn)只支持CSV格式。 |
|
Bucket
|
string | 是 |
存放清單文件的目標(biāo)桶的桶名。 |
|
Prefix
|
string | 否 |
生成的清單文件對象名會以此前綴開頭,如果不配置前綴,則生成的清單文件對象名默認(rèn)以BucketInventory開頭。 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
Frequency
|
string | 是 |
清單文件的生成周期,只支持按天和按周生成清單,第一次配置完桶清單,任務(wù)會在一個小時內(nèi)啟動,之后每隔一個周期啟動一次。 |
請求失敗響應(yīng)消息。
請求失敗響應(yīng)消息。 除了公共的錯誤碼外,此接口還會返回一些其他的錯誤碼。下面列出本接口的一些常見錯誤,以及可能原因。
| 錯誤碼 | 描述 | HTTP狀態(tài)碼 |
|---|---|---|
| NoSuchInventoryConfiguration | 沒有指定Id對應(yīng)的清單配置。 | 404 Not Found |
請求成功響應(yīng)消息。
