OBS使用PUT操作為一個(gè)桶配置清單規(guī)則,每個(gè)桶最多可以配置10條清單規(guī)則,有關(guān)更多桶清單的介紹和使用限制,請(qǐng)參考《 對(duì)象存儲(chǔ)服務(wù) 開發(fā)指南》的桶清單章節(jié)。
要使用此操作,需確保執(zhí)行者有PutBucketInventoryConfiguration操作的權(quán)限 。桶擁有者默認(rèn)具有此權(quán)限,并且可以將此權(quán)限授予其他人。
有關(guān)權(quán)限控制的更多信息請(qǐng)參考《 對(duì)象存儲(chǔ) 服務(wù)權(quán)限配置指南》的OBS權(quán)限控制概述章節(jié)。
| 名稱 | 類型 | 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)求的桶名稱。 |
|
inventory
|
string | query | 是 |
inventory表示請(qǐng)求桶清單API。 |
|
id
|
string | query | 是 |
清單配置的id,必須和消息體中的清單配置id一致。 有效字符:"a-z"、"A-Z"、"0-9"、"-"、"_"和"." |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
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ò)濾),如果沒有配置過(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中配置的字段。 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
Prefix
|
string | 否 |
前綴過(guò)濾條件,清單文件中只生成以此前綴開頭的對(duì)象列表。 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
Format
|
string | 是 |
生成的清單文件的格式,現(xiàn)只支持CSV格式。 |
|
Bucket
|
string | 是 |
存放清單文件的目標(biāo)桶的桶名。 |
|
Prefix
|
string | 否 |
生成的清單文件對(duì)象名會(huì)以此前綴開頭,如果不配置前綴,則生成的清單文件對(duì)象名默認(rèn)以BucketInventory開頭。 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
Frequency
|
string | 是 |
清單文件的生成周期,只支持按天和按周生成清單,第一次配置完桶清單,任務(wù)會(huì)在一個(gè)小時(shí)內(nèi)啟動(dòng),之后每隔一個(gè)周期啟動(dòng)一次。 |
請(qǐng)求成功響應(yīng)消息。
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
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,此類情況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)題。 |
請(qǐng)求失敗響應(yīng)消息。 除了公共的錯(cuò)誤碼外,此接口還會(huì)返回一些其他的錯(cuò)誤碼。下面列出本接口的一些常見錯(cuò)誤,以及可能原因。
| 錯(cuò)誤碼 | 描述 | HTTP狀態(tài)碼 |
|---|---|---|
| MalformedXML | 清單的XML配置格式錯(cuò)誤。 | 400 Bad Request |
| InvalidArgument | 無(wú)效參數(shù)。 | 400 Bad Request |
| InventoryCountOverLimit | 配置清單數(shù)量超過(guò)最大限制。 | 400 Bad Request |
| PrefixExistInclusionRelationship | 清單配置中的前綴存在包含關(guān)系。 | 400 Bad Request |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
Code
|
string | 否 |
錯(cuò)誤響應(yīng)消息體XML中錯(cuò)誤響應(yīng)對(duì)應(yīng)的HTTP消息返回碼,具體的錯(cuò)誤碼請(qǐng)參見錯(cuò)誤碼-表2。 |
|
Message
|
string | 否 |
錯(cuò)誤響應(yīng)消息體XML中具體錯(cuò)誤更全面、詳細(xì)的英文解釋,具體的錯(cuò)誤消息請(qǐng)參見錯(cuò)誤碼-表2。 |
|
RequestId
|
string | 否 |
本次錯(cuò)誤請(qǐng)求的請(qǐng)求ID,用于錯(cuò)誤定位。 |
|
HostId
|
string | 否 |
返回該消息的服務(wù)端ID。 |
|
Resource
|
string | 否 |
該錯(cuò)誤相關(guān)的桶或?qū)ο筚Y源。 |
