OBS允许在桶内保存静态的网页资源,如.html网页文件、flash文件、音视频文件等,当客户端通过桶的Website接入点访问这些对象资源时,浏览器可以直接解析出这些支持的网页资源,呈现给最终用户。典型的应用场景有:
重定向所有的请求到另外一个站点。 设定特定的重定向规则来重定向特定的请求。 本接口实现为桶创建或更新网站配置信息。
要正确执行此操作,需要确保执行者有PutBucketWebsite权限。默认情况下只有桶的所有者可以执行此操作,也可以通过设置桶策略或用户策略授权给其他用户。
说明: 1.尽量避免目标桶名中带有“.”,否则通过HTTPS访问时可能出现客户端校验证书出错。
2.设置桶的网络配置请求消息体的上限是10KB。
| 名称 | 类型 | 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。 |
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
RedirectAllRequestsTo
|
RedirectAllRequestsTo object | 是 |
描述所有请求的重定向行为,如果这个节点出现,所有其他的兄弟节点都不能出现。 |
|
IndexDocument
|
IndexDocument object | 是 |
Suff元素。 |
|
ErrorDocument
|
ErrorDocument object | 否 |
Key元素。 |
|
RoutingRules
|
RoutingRules object | 否 |
Routing元素。 |
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
HostName
|
string | 是 |
描述重定向的站点名。 |
|
Protocol
|
string | 否 |
描述重定向请求时使用的协议(http,https),默认使用http协议。 |
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
Suffix
|
string | 是 |
Suffix元素被追加在对文件夹的请求的末尾(例如:Suffix配置的是“index.html”,请求的是“samplebucket/images/”,返回的数据将是“samplebucket”桶内名为“images/index.html”的对象的内容)。Suffix元素不能为空或者包含“/”字符。 |
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
Key
|
string | 否 |
当4XX错误出现时使用的对象的名称。这个元素指定了当错误出现时返回的页面。 |
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
RoutingRule
|
RoutingRule object | 是 |
重定向规则的元素。一条重定向规则包含一个Condition和一个Redirect,当Condition匹配时,Redirect生效。 元素中至少要有一个RoutingRule元素 |
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
Condition
|
Condition object | 否 |
描述重定向规则匹配的条件的元素。 |
|
Redirect
|
Redirect object | 是 |
重定向信息的元素。可以重定向到另一个站点、另一个页面或使用另一个协议。当事件或错误发生时,可以指定不同的返回码。 |
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
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才可生效。 |
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
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 条件:有其他兄弟节点存在时非必选 |
请求成功响应消息。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
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创建来唯一确定本次请求的值,可以通过该值来定位问题。 |
请求失败响应消息。 除了公共的错误码外,此接口还会返回一些其他的错误码。下面列出本接口的一些常见错误,以及可能原因。
| 错误码 | 描述 | HTTP状态码 |
|---|---|---|
| InvalidTagError | 配置桶的网站配置时,提供了无效的Tag。 | 400 Bad Request |
| MalformedXMLError | 配置桶的网站配置时,提供的xml格式错误。 | 400 Bad Request |
