调用PutBucketWebsite接口将存储空间（Bucket）设置为静态网站托管模式并设置跳转规则（RoutingRule）。

注意事项

静态网站是指所有的网页都由静态内容构成，包括客户端执行的脚本，例如JavaScript。OSS不支持需要服务器端处理的内容，例如PHP、JSP、ASP.NET等。

  • 功能支持

    此接口主要用于设置默认主页、默认404页和RoutingRule。RoutingRule用来指定3xx跳转规则以及镜像回源规则。其中镜像回源支持公共云和金融云。

  • 使用自有域名访问静态网站

    如果要使用自有域名来访问基于Bucket的静态网站，您可以通过域名CNAME来实现。具体操作，请参见绑定自定义域名。

  • 索引页面和错误页面

    将一个Bucket设置为静态网站托管模式时，如果指定了索引页面或错误页面，则指定的索引页面和错误页面为该Bucket内的某个Object。

  • 对静态网站根域名的匿名访问

    将一个Bucket设置为静态网站托管模式后，对静态网站根域名的匿名访问，OSS将返回索引页面。对静态网站根域名的签名访问，OSS将返回GetBucket(ListObjects)的结果。

请求语法

PUT /?website HTTP/1.1
Date: GMT Date
Content-Length：ContentLength
Content-Type: application/xml
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Authorization: SignatureValue

<?xml version="1.0" encoding="UTF-8"?>
<WebsiteConfiguration>
    <IndexDocument>
        <Suffix>index.html</Suffix>
    </IndexDocument>
    <ErrorDocument>
        <Key>errorDocument.html</Key>
        <HttpStatus>404</HttpStatus>
    </ErrorDocument>
</WebsiteConfiguration>

请求头

此接口仅涉及公共请求头。更多信息，请参见公共请求头（Common Request Headers）。

请求参数

  • WebsiteConfiguration的内容
    名称 类型 是否必选 描述
    WebsiteConfiguration 容器 是 根节点。

    父节点：无
  • IndexDocument的内容
    名称 类型 是否必选 描述
    IndexDocument 容器 有条件

    至少指定IndexDocument、ErrorDocument、RoutingRules三个容器中的一个。

    		 默认主页的容器。

    父节点：WebsiteConfiguration
    Suffix 字符串 有条件

    如果指定了父节点IndexDocument，则必须指定此项。

    		 默认主页。

    设置默认主页后，如果访问以正斜线（/）结尾的Object，则OSS都会返回此默认主页。

    父节点：IndexDocument
    SupportSubDir 字符串 否 访问子目录时，是否支持转到子目录下的默认主页。取值范围如下：
    • true：转到子目录下的默认主页。
    • false（默认）：不转到子目录下的默认主页，而是转到根目录下的默认主页。

    假设默认主页为index.html，要访问bucket.oss-cn-hangzhou.aliyuncs.com/subdir/，如果设置SupportSubDir为false，则转到bucket.oss-cn-hangzhou.aliyuncs.com/index.html；如果设置SupportSubDir为true，则转到bucket.oss-cn-hangzhou.aliyuncs.com/subdir/index.html。

    父节点：IndexDocument
    Type 枚举值 否 设置默认主页后，访问以非正斜线（/）结尾的Object，且该Object不存在时的行为。 只有设置SupportSubDir为true时才生效，且生效的顺序在RoutingRule之后、ErrorFile之前。

    假设默认主页为index.html，要访问的文件路径为bucket.oss-cn-hangzhou.aliyuncs.com/abc，且abc这个Object不存在，此时Type的不同取值对应的行为如下：

    • 0（默认）：检查abc/index.html是否存在（即Object + 正斜线（/）+ 主页的形式），如果存在则返回302，Location头为/abc/的URL编码（即正斜线（/） + Object + 正斜线（/）的形式），如果不存在则返回404，继续检查ErrorFile。
    • 1：直接返回404，报错NoSuchKey，继续检查ErrorFile。
    • 2：检查abc/index.html是否存在，如果存在则返回该Object的内容；如果不存在则返回404，继续检查ErrorFile。

    父节点：IndexDocument
  • ErrorDocument的内容
    名称 类型 是否必选 描述
    ErrorDocument 容器 有条件

    至少指定IndexDocument、ErrorDocument、RoutingRules三个容器中的一个。

    		 404页面的容器。

    父节点：WebsiteConfiguration
    Key 字符串 有条件

    如果指定了父节点ErrorDocument，则必须指定此项。

    		 错误页面。

    指定错误页面后，如果访问的Object不存在，则返回此错误页面。

    父节点：ErrorDocument
    HttpStatus 字符串 否 返回错误页面时的HTTP状态码。

    取值：200、404（默认）

    父节点：ErrorDocument
  • RoutingRules|RoutingRule|RuleNumber的内容
    名称 类型 是否必选 描述
    RoutingRules 容器 有条件

    至少指定IndexDocument、ErrorDocument、RoutingRules三个容器中的一个。

    		 RoutingRule的容器。

    父节点：WebsiteConfiguration
    RoutingRule 容器 否 指定跳转规则或者镜像回源规则，最多指定20个RoutingRule。

    父节点：RoutingRules
    RuleNumber 正整数 有条件

    如果指定了父节点RoutingRule，则必须指定此项。

    		 匹配和执行RoutingRule的序号，OSS将按照此序号依次匹配规则。如果匹配成功，则执行此规则，后续的规则不再执行。

    父节点：RoutingRule
  • RoutingRules|RoutingRule|Condition的内容
    名称 类型 是否必选 描述
    Condition 容器 有条件

    如果指定了父节点RoutingRule，则必须指定此项。

    		 匹配的条件。

    如果指定的项都满足，则执行此规则。只有满足此容器下的各个节点的所有条件才算匹配。

    父节点：RoutingRule
    KeyPrefixEquals 字符串 否 只有匹配此前缀的Object才能匹配此规则。

    父节点：Condition
    HttpErrorCodeReturnedEquals HTTP状态码 否 访问指定Object时，返回此status才能匹配此规则。当跳转规则是镜像回源类型时，此字段必须为404。

    父节点：Condition
    IncludeHeader 容器 否 只有请求中包含了指定Header且值为指定值时，才能匹配此规则。该容器最多可指定10个。

    父节点：Condition
    Key 字符串 是 只有请求中包含了此Header且值为Equals的指定值时，才能匹配此规则。

    父节点：IncludeHeader
    Equals 字符串 否 只有请求中包含了Key指定的Header且值为指定值时，才能匹配此规则。

    父节点：IncludeHeader
    KeySuffixEquals 字符串 否 只有匹配此字段指定的后缀才能匹配此规则。

    默认值为空，表示不匹配指定的后缀。

    父节点：Condition
  • RoutingRules|RoutingRule|Redirect的内容
    名称 类型 是否必选 描述
    Redirect 容器 有条件

    如果指定了父节点RoutingRule，则必须指定此项。

    		 指定匹配此规则后执行的动作。

    父节点：RoutingRule
    RedirectType 字符串 有条件

    如果指定了父节点Redirect，则必须指定此项。

    		 指定跳转的类型。取值范围如下：
    • Mirror：镜像回源。
    • External：外部跳转，即OSS会返回一个3xx请求，指定跳转到另外一个地址。
    • AliCDN：阿里云CDN跳转，主要用于阿里云的CDN。与External不同的是，OSS会额外添加一个Header。阿里云CDN识别到此Header后会主动跳转到指定的地址，返回给用户获取到的数据，而不是将3xx跳转请求返回给用户。

    父节点：Redirect
    PassQueryString 布尔 否 执行跳转或者镜像回源规则时，是否携带请求参数。

    用户请求OSS时携带了请求参数?a=b&c=d，并且设置PassQueryString为true，如果规则为302跳转，则跳转的Location头中会添加此请求参数。例如Location:example.com?a=b&c=d，跳转类型为镜像回源，则在发起的回源请求中也会携带此请求参数。

    取值：true、false（默认）

    父节点：Redirect
    MirrorURL 字符串 有条件

    如果RedirectType指定为Mirror，则必须指定此项。

    		 镜像回源的源站地址。只有设置RedirectType为Mirror时才生效。

    源站地址必须以http://或者https://开头，并且以正斜线（/）结尾，OSS会在此地址后带上Object名称组成回源URL。

    例如要访问的Object名称为myobject，如果指定此项为http://example.com/，则回源URL为http://example.com/myobject，如果指定此项为http://example.com/dir1/，则回源URL为http://example.com/dir1/myobject。

    父节点：Redirect
    TransparentMirrorResponseCodes 字符串 否 指定当源站返回哪些状态码时需要透传该状态码以及body到客户端，取值为4xx、5xx等HTTP状态码，多个HTTP状态码之间用英文逗号（,）分隔，例如400,404。只有设置RedirectType为Mirror时才生效。

    当OSS向源站请求内容时，如果源站返回了此参数中的某个状态码，则OSS将透传源站返回的该状态码以及body到客户端。

    注意 如果在此参数中设置了404状态码，则设置的ErrorDocument会失效。

    父节点：Redirect
    MirrorPassQueryString 布尔 否 与PassQueryString作用相同，优先级高于PassQueryString。只有设置RedirectType为Mirror时才生效。

    默认值：false

    父节点：Redirect
    MirrorFollowRedirect 布尔 否 如果镜像回源获取的结果为3xx，是否继续跳转到指定的Location获取数据。 只有设置RedirectType为Mirror时才生效。

    例如发起镜像回源请求时，源站返回了302，并且指定了Location。

    • 如果设置此项为true，则OSS会继续请求Location对应的地址。

      最多能跳转10次，如果跳转超过10次，则返回镜像回源失败。

    • 如果设置此项为false，则OSS会返回302，并透传Location。

    默认值：true

    父节点：Redirect
    MirrorCheckMd5 布尔 否 是否检查回源body的MD5。 只有设置RedirectType为Mirror时才生效。

    当设置MirrorCheckMd5为true，并且源站返回的response中含有Content-Md5头时，OSS检查拉取的数据MD5是否与此Header匹配，如果不匹配，则不保存在OSS上。

    默认值：false

    父节点：Redirect
    MirrorHeaders 容器 否 指定镜像回源时携带的Header。只有设置RedirectType为Mirror时才生效。

    父节点：Redirect
    PassAll 布尔 否 是否透传除以下Header之外的其他Header到源站。只有设置RedirectType为Mirror时才生效。
    • content-length、authorization2、authorization、range、date等Header
    • 以oss-/x-oss-/x-drs-开头的Header

    默认值：false

    父节点：MirrorHeaders
    Pass 字符串 否 透传指定的Header到源站。只有设置RedirectType为Mirror时才生效。

    每个Header长度最多为1024个字节，字符集为0~9、A~Z、a~z以及短划线（-）。

    此字段最多可指定10个。

    父节点：MirrorHeaders
    Remove 字符串 否 禁止透传指定的Header到源站。只有设置RedirectType为Mirror时才生效。

    每个Header长度最多为1024个字节，字符集与Pass相同。

    此字段最多可指定10个，通常与PassAll一起使用。

    父节点：MirrorHeaders
    Set 容器 否 设置一个Header传到源站，不管请求中是否携带这些指定的Header，回源时都会设置这些Header。只有设置RedirectType为Mirror时才生效。

    此容器最多可指定10组。

    父节点：MirrorHeaders
    Key 字符串 有条件

    若指定了父节点Set，则必须指定此项。

    		 设置Header的key，最多1024个字节，字符集与Pass相同。只有设置RedirectType为Mirror时才生效。

    父节点：Set
    Value 字符串 有条件

    若指定了父节点Set，则必须指定此项。

    		 设置Header的value，最多1024个字节，不能出现\r\n。只有设置RedirectType为Mirror时才生效。

    父节点：Set
    Protocol 字符串 否 跳转时的协议。只有设置RedirectType为External或者AliCDN时才生效。

    如果要访问的文件为test，设置跳转到example.com，并且设置Protocol为https，则Location头为https://example.com/test。

    取值：http、https。

    父节点：Redirect
    HostName 字符串 否 跳转时的域名，域名需符合域名规范。

    如果要访问的文件为test，设置Protocol为https，并且设置Hostname为example.com，则Location头为https://example.com/test。

    父节点：Redirect
    ReplaceKeyPrefixWith 字符串 否 Redirect时Object名称的前缀将替换成该值。如果前缀为空，则将这个字符串插入Object名称的前面。
    说明 仅允许存在ReplaceKeyWith或ReplaceKeyPrefixWith节点。

    假设要访问的Object为abc/test.txt，如果设置KeyPrefixEquals为abc/，ReplaceKeyPrefixWith为def/，则Location头为http://example.com/def/test.txt。

    父节点：Redirect
    EnableReplacePrefix 布尔 否 如果设置此字段为true，则Object的前缀将被替换为ReplaceKeyPrefixWith指定的值。如果未指定此字段或为空，则表示截断Object前缀。
    说明 当ReplaceKeyWith字段不为空时，不能设置此字段为true。

    默认值：false

    父节点：Redirect
    ReplaceKeyWith 字符串 否 Redirect时Object名称将替换成ReplaceKeyWith指定的值，ReplaceKeyWith支持设置变量。目前支持的变量为${key}，表示该请求中的Object名称。

    假设要访问的Object为test，如果设置ReplaceKeyWith为prefix/${key}.suffix，则Location头为http://example.com/prefix/test.suffix。

    父节点：Redirect
    HttpRedirectCode HTTP状态码 否 跳转时返回的状态码。只有设置RedirectType为External或者AliCDN时才生效。

    取值：301（默认）、302、307。

    父节点：Redirect

响应头

此接口仅涉及公共响应头。更多信息，请参见公共响应头（Common Response Headers）。

示例

  • 请求示例
    PUT /?website HTTP/1.1
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
Content-Length: 209
Date: Fri, 04 May 2012 03:21:12 GMT
Authorization: OSS nxj7dtwhcyl5hp****:sNKIHT6ci/z231yIT5vYnetD****

<?xml version="1.0" encoding="UTF-8"?>
<WebsiteConfiguration>
  <IndexDocument>
    <Suffix>index.html</Suffix>
      <SupportSubDir>true</SupportSubDir>
      <Type>0</Type>
  </IndexDocument>
  <ErrorDocument>
    <Key>error.html</Key>
    <HttpStatus>404</HttpStatus>
  </ErrorDocument>
</WebsiteConfiguration>
  • 返回示例
    HTTP/1.1 200 OK
x-oss-request-id: 534B371674E88A4D8906008B
Date: Fri, 04 May 2012 03:21:12 GMT
Content-Length: 0
Connection: keep-alive
Server: AliyunOSS
  • 完整示例
    PUT /?website HTTP/1.1
Date: Fri, 27 Jul 2018 09:03:18 GMT
Content-Length: 2064
Host: test.oss-cn-hangzhou-internal.aliyuncs.com
Authorization: OSS nxj7dtwhcyl5hp****:sNKIHT6ci/z231yIT5vYnetD****
User-Agent: aliyun-sdk-python-test/0.4.0

<WebsiteConfiguration>
  <IndexDocument>
    <Suffix>index.html</Suffix>
    <SupportSubDir>true</SupportSubDir>
    <Type>0</Type>
  </IndexDocument>
  <ErrorDocument>
    <Key>error.html</Key>
    <HttpStatus>404</HttpStatus>
  </ErrorDocument>
  <RoutingRules>
    <RoutingRule>
      <RuleNumber>1</RuleNumber>
      <Condition>
        <KeyPrefixEquals>abc/</KeyPrefixEquals>
        <HttpErrorCodeReturnedEquals>404</HttpErrorCodeReturnedEquals>
      </Condition>
      <Redirect>
        <RedirectType>Mirror</RedirectType>
        <PassQueryString>true</PassQueryString>
        <MirrorURL>http://example.com/</MirrorURL>
     <TransparentMirrorResponseCodes>400,404</TransparentMirrorResponseCodes>      
        <MirrorPassQueryString>true</MirrorPassQueryString>
        <MirrorFollowRedirect>true</MirrorFollowRedirect>
        <MirrorCheckMd5>false</MirrorCheckMd5>
        <MirrorHeaders>
          <PassAll>true</PassAll>
          <Pass>myheader-key1</Pass>
          <Pass>myheader-key2</Pass>
          <Remove>myheader-key3</Remove>
          <Remove>myheader-key4</Remove>
          <Set>
            <Key>myheader-key5</Key>
            <Value>myheader-value5</Value>
          </Set>
        </MirrorHeaders>
      </Redirect>
    </RoutingRule>
    <RoutingRule>
      <RuleNumber>2</RuleNumber>
      <Condition>
        <KeyPrefixEquals>abc/</KeyPrefixEquals>
        <HttpErrorCodeReturnedEquals>404</HttpErrorCodeReturnedEquals>
        <IncludeHeader>
          <Key>host</Key>
          <Equals>test.oss-cn-beijing-internal.aliyuncs.com</Equals>
        </IncludeHeader>
      </Condition>
      <Redirect>
        <RedirectType>AliCDN</RedirectType>
        <Protocol>http</Protocol>
        <HostName>example.com</HostName>
        <PassQueryString>false</PassQueryString>
        <ReplaceKeyWith>prefix/${key}.suffix</ReplaceKeyWith>
        <HttpRedirectCode>301</HttpRedirectCode>
      </Redirect>
    </RoutingRule>
    <RoutingRule>
      <Condition>
        <HttpErrorCodeReturnedEquals>404</HttpErrorCodeReturnedEquals>
      </Condition>
      <RuleNumber>3</RuleNumber>
      <Redirect>
        <ReplaceKeyWith>prefix/${key}</ReplaceKeyWith>
        <HttpRedirectCode>302</HttpRedirectCode>
        <EnableReplacePrefix>false</EnableReplacePrefix>
        <PassQueryString>false</PassQueryString>
        <Protocol>http</Protocol>
        <HostName>example.com</HostName>
        <RedirectType>External</RedirectType>
      </Redirect>
    </RoutingRule>
  </RoutingRules>
</WebsiteConfiguration>

HTTP/1.1 200 OK
Server: AliyunOSS
Date: Fri, 27 Jul 2018 09:03:18 GMT
Content-Length: 0
Connection: keep-alive
x-oss-request-id: 5B5ADFD6ED3CC49176CBE29D
x-oss-server-time: 47

SDK

错误码

错误码 HTTP状态码 描述
InvalidDigest 400 上传了Content-MD5请求头后，OSS会计算消息体的Content-MD5并检查一致性，如果不一致则返回此错误码。