华为云计算 云知识 获取桶的网站配置GetBucketWebsite
获取桶的网站配置GetBucketWebsite

 

接口说明

获取该桶设置的网站配置信息。

要正确执行此操作,需要确保执行者有GetBucketWebsite执行权限。默认情况下只有桶的所有者可以执行此操作,也可以通过设置桶策略或用户策略授权给其他用户。

URL
GET  https://obs.cn-north-4.myhuaweicloud.com/ 
请求参数
名称 类型 IN 必选 描述
Authorization
 
string header

请求消息中可带的签名信息。

Date
 
string header

请求发起端的日期和时间,例如:Wed, 27 Jun 2018 13:39:15 +0000。 默认值:无。 条件:如果消息头中带了x-obs-date字段,则可以不带该字段,其他情况下必选。

bucket_name
 
string query

请求的桶名称。

website
 
string query

website表示请求桶的网站配置API。

返回参数
返回码: 200

请求成功响应消息。

名称 类型 必选 描述
Content-Length
 
string

响应消息体的字节长度。

Connection
 
string

指明与服务器的连接是长连接还是短连接。

Date
 
string

OBS系统响应的时间。

ETag
 
string

对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识,可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A,下载对象时ETag为B,则说明对象内容发生了变化。实际的ETag是对象的哈希值。ETag只反映变化的内容,而不是其元数据。上传的对象或拷贝操作创建的对象,通过MD5加密后都有唯一的ETag。如果通过多段上传对象,则无论加密方法如何,MD5会拆分ETag,此类情况ETag就不是MD5的摘要。

x-obs-id-2
 
string

帮助定位问题的特殊符号。

x-obs-request-id
 
string

由OBS创建来唯一确定本次请求的值,可以通过该值来定位问题。

名称 类型 必选 描述
WebsiteConfiguration
 
SetBucketWebsiteRequestBody object

网站配置的根节点。

200 WebsiteConfiguration
名称 类型 必选 描述
RedirectAllRequestsTo
 
RedirectAllRequestsTo object

描述所有请求的重定向行为,如果这个节点出现,所有其他的兄弟节点都不能出现。

IndexDocument
 
IndexDocument object

Suff元素。

ErrorDocument
 
ErrorDocument object

Key元素。

RoutingRules
 
RoutingRules object

Routing元素。

200 WebsiteConfiguration.RedirectAllRequestsTo
名称 类型 必选 描述
HostName
 
string

描述重定向的站点名。

Protocol
 
string

描述重定向请求时使用的协议(http,https),默认使用http协议。

200 WebsiteConfiguration.IndexDocument
名称 类型 必选 描述
Suffix
 
string

Suffix元素被追加在对文件夹的请求的末尾(例如:Suffix配置的是“index.html”,请求的是“samplebucket/images/”,返回的数据将是“samplebucket”桶内名为“images/index.html”的对象的内容)。Suffix元素不能为空或者包含“/”字符。

200 WebsiteConfiguration.ErrorDocument
名称 类型 必选 描述
Key
 
string

当4XX错误出现时使用的对象的名称。这个元素指定了当错误出现时返回的页面。

200 WebsiteConfiguration.RoutingRules
名称 类型 必选 描述
RoutingRule
 
RoutingRule object

重定向规则的元素。一条重定向规则包含一个Condition和一个Redirect,当Condition匹配时,Redirect生效。 元素中至少要有一个RoutingRule元素

200 WebsiteConfiguration.RoutingRules.RoutingRule
名称 类型 必选 描述
Condition
 
Condition object

描述重定向规则匹配的条件的元素。

Redirect
 
Redirect object

重定向信息的元素。可以重定向到另一个站点、另一个页面或使用另一个协议。当事件或错误发生时,可以指定不同的返回码。

200 WebsiteConfiguration.RoutingRules.RoutingRule.Condition
名称 类型 必选 描述
KeyPrefixEquals
 
string

描述当重定向生效时对象名的前缀。

例如:

重定向ExamplePage.html对象的请求,KeyPrefixEquals设为ExamplePage.html。 类型:字符串

父节点:Condition

条件:父节点Condition存在,并且兄弟节点HttpErrorCodeReturnedEquals不存在。如果设定了两个条件,只有都匹配时,Redirect才生效。

HttpErrorCodeReturnedEquals
 
string

描述Redirect生效时的HTTP错误码。当发生错误时,如果错误码等于这个值,那么Redirect生效。

例如:

当返回的http错误码为404时重定向到NotFound.html,可以将Condition中的HttpErrorCodeReturnedEquals设置为404,Redirect中的ReplaceKeyWith设置为NotFound.html。 类型:字符串

父节点:Condition

条件:父节点Condition存在,并且兄弟节点KeyPrefixEquals不存在。如果设定了多个条件,需要同时匹配所有的条件,Redirect才可生效。

200 WebsiteConfiguration.RoutingRules.RoutingRule.Redirect
名称 类型 必选 描述
Protocol
 
string

描述重定向请求时使用的协议。

类型:字符串

父节点:Redirect

可选值:http、https

条件:有其他兄弟节点存在时非必选

HostName
 
string

描述重定向请求时使用的站点名。

类型:字符串

父节点:Redirect

条件:有其他兄弟节点存在时非必选

ReplaceKeyPrefixWith
 
string

描述重定向请求时使用的对象名前缀。

例如:

想把所有对docs(目录下的对象)的请求重定向到documents(目录下的对象),可以将Condition中的KeyPrefixEquals设置为docs,Redirect中的ReplaceKeyPrefixWith设置为documents。 类型:字符串

父节点:Redirect

条件:有其他兄弟节点存在时非必选,不可与ReplaceKeyWith同时存在

ReplaceKeyWith
 
string

描述重定向请求时使用的对象名。例如:重定向请求到error.html。

类型:字符串

父节点:Redirect

条件:有其他兄弟节点存在时非必选,不可与ReplaceKeyPrefixWith同时存在

HttpRedirectCode
 
string

描述响应中的HTTP状态码。

类型:字符串

父节点:Redirect

条件:有其他兄弟节点存在时非必选

返回码: 400

请求失败响应消息。 除了公共的错误码外,此接口还会返回一些其他的错误码。下面列出本接口的一些常见错误,以及可能原因。

错误码 描述 HTTP状态码
NoSuchWebsiteConfiguration 桶的Website配置不存在。 404 Not Found
名称 类型 必选 描述
Code
 
string

错误响应消息体XML中错误响应对应的HTTP消息返回码,具体的错误码请参见错误码-表2

Message
 
string

错误响应消息体XML中具体错误更全面、详细的英文解释,具体的错误消息请参见错误码-表2

RequestId
 
string

本次错误请求的请求ID,用于错误定位。

HostId
 
string

返回该消息的服务端ID。

Resource
 
string

该错误相关的桶或对象资源。

请求示例
示例 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

请求成功响应消息。

示例 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>www.huaweicloud.com</HostName> </RedirectAllRequestsTo> </WebsiteConfiguration>
错误码
请参考 错误码说明

 

上一篇:【荣誉】金山办公受邀出席第七届中国行业互联网大会 获评“2021年度优秀数字化解决方案提供商” 下一篇:远程办公软件哪个好?免费好用的远程办公软件推荐

云速建站 CloudSite  

华为云建站为您提供上千套网站模板,覆盖上百行业,无论您需要个人网站模版、企业网站模版、电商行业模板还是HTML5网站模版、H5响应式网站模板,华为云建站都能满足您的需求,让您零基础快速搭建个人网站,企业网站、电商网站。五站合一:PC+移动+小程序+微信公众号+APP。