獲取指定桶的 消息通知 配置信息。
為了能成功執(zhí)行此配置操作,需要確保執(zhí)行者擁有GetBucketNotification權(quán)限。默認(rèn)情況下只有桶的所有者擁有該權(quán)限,但可以通過設(shè)置桶策略或用戶策略授權(quán)給其他用戶。
| 名稱 | 類型 | IN | 必選 | 描述 |
|---|---|---|---|---|
|
Authorization
|
string | header | 是 |
請(qǐng)求消息中可帶的簽名信息。 |
|
Date
|
string | header | 否 |
請(qǐng)求發(fā)起端的日期和時(shí)間,例如:Wed, 27 Jun 2018 13:39:15 +0000。 默認(rèn)值:無。 條件:如果消息頭中帶了x-obs-date字段,則可以不帶該字段,其他情況下必選。 |
|
bucket_name
|
string | query | 是 |
請(qǐng)求的桶名稱。 |
|
notification
|
string | query | 是 |
notification表示請(qǐng)求桶的消息通知配置API。 |
請(qǐng)求成功響應(yīng)消息。
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
Content-Length
|
string | 否 |
響應(yīng)消息體的字節(jié)長度。 |
|
Connection
|
string | 否 |
指明與服務(wù)器的連接是長連接還是短連接。 |
|
Date
|
string | 否 |
OBS系統(tǒng)響應(yīng)的時(shí)間。 |
|
ETag
|
string | 否 |
對(duì)象的base64編碼的128位MD5摘要。ETag是對(duì)象內(nèi)容的唯一標(biāo)識(shí),可以通過該值識(shí)別對(duì)象內(nèi)容是否有變化。比如上傳對(duì)象時(shí)ETag為A,下載對(duì)象時(shí)ETag為B,則說明對(duì)象內(nèi)容發(fā)生了變化。實(shí)際的ETag是對(duì)象的哈希值。ETag只反映變化的內(nèi)容,而不是其元數(shù)據(jù)。上傳的對(duì)象或拷貝操作創(chuàng)建的對(duì)象,通過MD5加密后都有唯一的ETag。如果通過多段上傳對(duì)象,則無論加密方法如何,MD5會(huì)拆分ETag,此類情況ETag就不是MD5的摘要。 |
|
x-obs-id-2
|
string | 否 |
幫助定位問題的特殊符號(hào)。 |
|
x-obs-request-id
|
string | 否 |
由OBS創(chuàng)建來唯一確定本次請(qǐng)求的值,可以通過該值來定位問題。 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
NotificationConfiguration
|
SetBucketNotificationRequestBody object | 否 |
配置桶事件通知的根元素,如果子元素為空,說明消息通知功能處于關(guān)閉狀態(tài)。 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
TopicConfiguration
|
Array of TopicConfiguration objects | 否 | |
|
FunctionStageConfiguration
|
Array of FunctionStageConfiguration objects | 否 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
Id
|
string | 否 |
每項(xiàng)事件通知配置的唯一標(biāo)識(shí),若是用戶未指定ID,系統(tǒng)將自動(dòng)分配一個(gè)ID。 |
|
Filter
|
Filter object | 否 |
Object的元素,用以保存過濾對(duì)象名的一組規(guī)則。 |
|
Topic
|
string | 否 |
事件通知主題的URN,當(dāng)OBS檢測到桶中發(fā)生特定的事件后,將會(huì)發(fā)布通知消息至該主題,可以在消息通知服務(wù)主題部分找到具體值。 模板:<Topic>urn:smn:region:project_id:smn_topic</Topic> |
|
Event
|
string | 否 |
需要發(fā)布通知消息的事件類型。 說明:在一個(gè)TopicConfiguration、FunctionStageConfiguration配置項(xiàng)中可以添加多個(gè)事件類型。 合法值: 上傳對(duì)象操作可以取以下值: ObjectCreated:Put ObjectCreated:Post ObjectCreated:Copy ObjectCreated:CompleteMultipartUpload 或者使用通配符支持所有上傳操作 ObjectCreated:* 刪除對(duì)象操作可以取以下值: ObjectRemoved:Delete ObjectRemoved:DeleteMarkerCreated 或者使用通配符支持所有刪除操作 ObjectRemoved:* |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
Object
|
FilterObject object | 否 |
定義過濾規(guī)則的元素,該規(guī)則用以匹配對(duì)象名前綴和后綴。 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
FilterRule
|
Array of FilterRule objects | 否 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
Name
|
string | 否 |
指定規(guī)則按對(duì)象名前綴或后綴進(jìn)行過濾。 |
|
Value
|
string | 否 |
指定的對(duì)象名關(guān)鍵字,根據(jù)Name元素定義的前綴或后綴,輸入需要過濾的對(duì)象的關(guān)鍵字信息,字符越長匹配精度越高,最大可支持1024個(gè)字符。 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
Id
|
string | 否 |
每項(xiàng)事件通知配置的唯一標(biāo)識(shí),若是用戶未指定ID,系統(tǒng)將自動(dòng)分配一個(gè)ID。 |
|
Filter
|
Filter object | 否 |
Object的元素,用以保存過濾對(duì)象名的一組規(guī)則。 |
|
Topic
|
string | 否 |
事件通知主題的URN,當(dāng)OBS檢測到桶中發(fā)生特定的事件后,將會(huì)發(fā)布通知消息至該主題,可以在消息通知服務(wù)主題部分找到具體值。 模板:<Topic>urn:smn:region:project_id:smn_topic</Topic> |
|
Event
|
string | 否 |
需要發(fā)布通知消息的事件類型。 說明:在一個(gè)TopicConfiguration、FunctionStageConfiguration配置項(xiàng)中可以添加多個(gè)事件類型。 合法值: 上傳對(duì)象操作可以取以下值: ObjectCreated:Put ObjectCreated:Post ObjectCreated:Copy ObjectCreated:CompleteMultipartUpload 或者使用通配符支持所有上傳操作 ObjectCreated:* 刪除對(duì)象操作可以取以下值: ObjectRemoved:Delete ObjectRemoved:DeleteMarkerCreated 或者使用通配符支持所有刪除操作 ObjectRemoved:* |
|
FunctionStage
|
string | 否 |
函數(shù)服務(wù)中函數(shù)的URN,當(dāng)OBS檢測到桶中發(fā)生特定的事件后,將會(huì)發(fā)送消息至函數(shù)服務(wù)調(diào)用執(zhí)行該函數(shù)。 若添加父元素FunctionStageConfiguration,本元素是必選項(xiàng)。 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
Object
|
FilterObject object | 否 |
定義過濾規(guī)則的元素,該規(guī)則用以匹配對(duì)象名前綴和后綴。 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
FilterRule
|
Array of FilterRule objects | 否 |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
Name
|
string | 否 |
指定規(guī)則按對(duì)象名前綴或后綴進(jìn)行過濾。 |
|
Value
|
string | 否 |
指定的對(duì)象名關(guān)鍵字,根據(jù)Name元素定義的前綴或后綴,輸入需要過濾的對(duì)象的關(guān)鍵字信息,字符越長匹配精度越高,最大可支持1024個(gè)字符。 |
請(qǐng)求失敗響應(yīng)消息。 除了公共的錯(cuò)誤碼外,此接口還會(huì)返回一些其他的錯(cuò)誤碼。下面列出本接口的一些常見錯(cuò)誤,以及可能原因。
| 錯(cuò)誤碼 | 描述 | HTTP狀態(tài)碼 |
|---|---|---|
| InvalidArgument | 該錯(cuò)誤可能是由于下列原因?qū)е?。指定了不支持的event。指定的URN不存在或者填寫錯(cuò)誤,請(qǐng)確認(rèn)URN合法。指定的URN中的區(qū)域與桶所在的區(qū)域不一致,請(qǐng)確保桶所在的區(qū)域與URN中的區(qū)域一致。指定的過濾規(guī)則之間存在互相包含或者重疊。 | 400 Bad Request |
| AccessDenied | 執(zhí)行者不是桶的所有者,或者還未被授權(quán)PutBucketNotification權(quán)限。 | 403 Forbidden |
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
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源。 |
請(qǐng)求成功響應(yīng)消息。
