華為云計算 云知識 獲取桶的網(wǎng)站配置GetBucketWebsite
獲取桶的網(wǎng)站配置GetBucketWebsite

 

接口說明

獲取該桶設(shè)置的網(wǎng)站配置信息。

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

URL
GET  https://obs.cn-north-4.myhuaweicloud.com/ 
請求參數(shù)
名稱 類型 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

請求的桶名稱。

website
 
string query

website表示請求桶的網(wǎng)站配置API。

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

請求成功響應(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)建來唯一確定本次請求的值,可以通過該值來定位問題。

名稱 類型 必選 描述
WebsiteConfiguration
 
SetBucketWebsiteRequestBody object

網(wǎng)站配置的根節(jié)點。

200 WebsiteConfiguration
名稱 類型 必選 描述
RedirectAllRequestsTo
 
RedirectAllRequestsTo object

描述所有請求的重定向行為,如果這個節(jié)點出現(xiàn),所有其他的兄弟節(jié)點都不能出現(xiàn)。

IndexDocument
 
IndexDocument object

Suff元素。

ErrorDocument
 
ErrorDocument object

Key元素。

RoutingRules
 
RoutingRules object

Routing元素。

200 WebsiteConfiguration.RedirectAllRequestsTo
名稱 類型 必選 描述
HostName
 
string

描述重定向的站點名。

Protocol
 
string

描述重定向請求時使用的協(xié)議(http,https),默認(rèn)使用http協(xié)議。

200 WebsiteConfiguration.IndexDocument
名稱 類型 必選 描述
Suffix
 
string

Suffix元素被追加在對文件夾的請求的末尾(例如:Suffix配置的是“index.html”,請求的是“samplebucket/images/”,返回的數(shù)據(jù)將是“samplebucket”桶內(nèi)名為“images/index.html”的對象的內(nèi)容)。Suffix元素不能為空或者包含“/”字符。

200 WebsiteConfiguration.ErrorDocument
名稱 類型 必選 描述
Key
 
string

當(dāng)4XX錯誤出現(xiàn)時使用的對象的名稱。這個元素指定了當(dāng)錯誤出現(xiàn)時返回的頁面。

200 WebsiteConfiguration.RoutingRules
名稱 類型 必選 描述
RoutingRule
 
RoutingRule object

重定向規(guī)則的元素。一條重定向規(guī)則包含一個Condition和一個Redirect,當(dāng)Condition匹配時,Redirect生效。 元素中至少要有一個RoutingRule元素

200 WebsiteConfiguration.RoutingRules.RoutingRule
名稱 類型 必選 描述
Condition
 
Condition object

描述重定向規(guī)則匹配的條件的元素。

Redirect
 
Redirect object

重定向信息的元素。可以重定向到另一個站點、另一個頁面或使用另一個協(xié)議。當(dāng)事件或錯誤發(fā)生時,可以指定不同的返回碼。

200 WebsiteConfiguration.RoutingRules.RoutingRule.Condition
名稱 類型 必選 描述
KeyPrefixEquals
 
string

描述當(dāng)重定向生效時對象名的前綴。

例如:

重定向ExamplePage.html對象的請求,KeyPrefixEquals設(shè)為ExamplePage.html。 類型:字符串

父節(jié)點:Condition

條件:父節(jié)點Condition存在,并且兄弟節(jié)點HttpErrorCodeReturnedEquals不存在。如果設(shè)定了兩個條件,只有都匹配時,Redirect才生效。

HttpErrorCodeReturnedEquals
 
string

描述Redirect生效時的HTTP錯誤碼。當(dāng)發(fā)生錯誤時,如果錯誤碼等于這個值,那么Redirect生效。

例如:

當(dāng)返回的http錯誤碼為404時重定向到NotFound.html,可以將Condition中的HttpErrorCodeReturnedEquals設(shè)置為404,Redirect中的ReplaceKeyWith設(shè)置為NotFound.html。 類型:字符串

父節(jié)點:Condition

條件:父節(jié)點Condition存在,并且兄弟節(jié)點KeyPrefixEquals不存在。如果設(shè)定了多個條件,需要同時匹配所有的條件,Redirect才可生效。

200 WebsiteConfiguration.RoutingRules.RoutingRule.Redirect
名稱 類型 必選 描述
Protocol
 
string

描述重定向請求時使用的協(xié)議。

類型:字符串

父節(jié)點:Redirect

可選值:http、https

條件:有其他兄弟節(jié)點存在時非必選

HostName
 
string

描述重定向請求時使用的站點名。

類型:字符串

父節(jié)點:Redirect

條件:有其他兄弟節(jié)點存在時非必選

ReplaceKeyPrefixWith
 
string

描述重定向請求時使用的對象名前綴。

例如:

想把所有對docs(目錄下的對象)的請求重定向到documents(目錄下的對象),可以將Condition中的KeyPrefixEquals設(shè)置為docs,Redirect中的ReplaceKeyPrefixWith設(shè)置為documents。 類型:字符串

父節(jié)點:Redirect

條件:有其他兄弟節(jié)點存在時非必選,不可與ReplaceKeyWith同時存在

ReplaceKeyWith
 
string

描述重定向請求時使用的對象名。例如:重定向請求到error.html。

類型:字符串

父節(jié)點:Redirect

條件:有其他兄弟節(jié)點存在時非必選,不可與ReplaceKeyPrefixWith同時存在

HttpRedirectCode
 
string

描述響應(yīng)中的HTTP狀態(tài)碼。

類型:字符串

父節(jié)點:Redirect

條件:有其他兄弟節(jié)點存在時非必選

返回碼: 400

請求失敗響應(yīng)消息。 除了公共的錯誤碼外,此接口還會返回一些其他的錯誤碼。下面列出本接口的一些常見錯誤,以及可能原因。

錯誤碼 描述 HTTP狀態(tài)碼
NoSuchWebsiteConfiguration 桶的Website配置不存在。 404 Not Found
名稱 類型 必選 描述
Code
 
string

錯誤響應(yīng)消息體XML中錯誤響應(yīng)對應(yīng)的HTTP消息返回碼,具體的錯誤碼請參見錯誤碼-表2。

Message
 
string

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

RequestId
 
string

本次錯誤請求的請求ID,用于錯誤定位。

HostId
 
string

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

Resource
 
string

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

請求示例
示例 1
 
"/?website"
 
"GET /?website HTTP/1.1\nUser-Agent: curl/7.29.0\nHost: examplebucket.obs.cn-north-4.myhuaweicloud.com\nAccept: */*\nDate: WED, 01 Jul 2015 03:41:54 GMT\nAuthorization: OBS H4IPJX0TQTHTHEBQQCEC:Yxt1Ru+feHE0S94R7dcBp+hfLnI=\n"
返回示例
返回碼:200

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

示例 1
 
HTTP/1.1 200 OK Server: OBS x-obs-request-id: BF2600000164363442EC03A8CA3DD7F5 x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAA BCS FbGOmlN0BVp1kbwN3har8jbVvtKEKN Content-Type: application/xml Date: WED, 01 Jul 2015 03:41:54 GMT Content-Length: 250 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <WebsiteConfiguration xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/"> <RedirectAllRequestsTo> <HostName>m.cqfng.cn</HostName> </RedirectAllRequestsTo> </WebsiteConfiguration>
錯誤碼
請參考 錯誤碼說明