GetBucketWebsite

Note

The oss:GetBucketWebsite permission is required for calling the GetBucketWebsite operation to query the static website hosting status and redirection rules configured for a bucket. For more information, see Attach a custom policy to a RAM user.

Request structure

GET /?website HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue

Request headers

A GetBucketWebsite request contains only common request headers. For more information, see Common request headers.

Response headers

The response to a GetBucketWebsite request contains only common response headers. For more information, see Common response headers.

Response elements

• The following table describes the element for WebsiteConfiguration in the response to a GetBucketWebsite request.

  Element	Type	Example	Description

  Element	Type	Example	Description
  WebsiteConfiguration	Container	N/A	The root node. Parent nodes: none

• The following table describes the elements for IndexDocument in the response to a GetBucketWebsite request.

  Element	Type	Example	Description

  Element	Type	Example	Description
  IndexDocument	Container	N/A	The container used to store the default homepage. Parent nodes: WebsiteConfiguration
  Suffix	String	index.html	The default homepage. Parent nodes: IndexDocument

• The following table describes the elements for ErrorDocument in the response to a GetBucketWebsite request.

  Element	Type	Example	Description

  Element	Type	Example	Description
  ErrorDocument	Container	N/A	The container used to store the error page. Parent nodes: WebsiteConfiguration
  Key	String	error.html	The error page. Parent nodes: ErrorDocument
  HttpStatus	String	404	The HTTP status code returned with the error page. Parent nodes: ErrorDocument

• The following table describes the elements for RoutingRules, RoutingRule, and RuleNumber in the response to a GetBucketWebsite request.

  Element	Type	Example	Description

  Element	Type	Example	Description
  RoutingRules	Container	N/A	The container used to store RoutingRule. Parent nodes: WebsiteConfiguration
  RoutingRule	Container	N/A	The redirection rule or mirroring-based back-to-origin rule. Parent nodes: RoutingRules
  RuleNumber	Positive integer	1	The sequence number used to match and run redirection rules or mirroring-based back-to-origin rules. Redirection rules are matched based on this element. If a match succeeds, only the rule is run and the subsequent rules are not run. Parent nodes: RoutingRule

• The following table describes the elements for RoutingRules, RoutingRule, and Condition in the response to a GetBucketWebsite request.

  Element	Type	Example	Description

  Element	Type	Example	Description
  Condition	Container	N/A	The matching condition. The rule is run only when all the specified conditions are met. Parent nodes: RoutingRule
  KeyPrefixEquals	String	abc	The prefix of object names. Only objects whose names contain the specified prefix match the rule. Parent nodes: Condition
  HttpErrorCodeReturnedEquals	HTTP status code	404	The returned HTTP status code. The rule is matched only when the specified object is accessed and the specified status code is returned. If the redirection rule is the mirroring-based back-to-origin rule, the value of this element is 404. Parent nodes: Condition
  IncludeHeader	Container	N/A	The header specified in the request. The rule is matched only when the specified header is included in the request and the header value is equal to the specified value. Up to five IncludeHeader containers can be specified. Parent nodes: IncludeHeader
  Key	String	host	The key of the header. The rule is matched only when the specified header is included in the request and the header value equals the value specified by Equals. Parent nodes: IncludeHeader
  Equals	String	test.oss-cn-beijing-internal.aliyuncs.com	The value of the header. The rule is matched only when the header specified by Key is included in the request and the header value equals the specified value. Parent nodes: IncludeHeader

• The following table describes the elements for RoutingRules, RoutingRule, and Redirect in the response to a GetBucketWebsite request.

  Element	Type	Example	Description

  Element	Type	Example	Description
  Redirect	Container	N/A	The operation to perform after the rule is matched. Parent nodes: RoutingRule
  RedirectType	String	Mirror	The redirection type. Mirror: mirroring-based back-to-origin. External: external redirection. Object Storage Service (OSS) returns the 3xx HTTP redirect code and the Location header for you to redirect the access to another IP address. AliCDN: redirection based on Alibaba Cloud Content Delivery Network (CDN). OSS adds an additional header to the request, which is different from the External type. After CDN identifies the header, CDN redirects the access to the specified IP address and returns the obtained data instead of the redirect request to the user. Parent nodes: Redirect
  PassQueryString	Boolean	false	Indicates whether the request parameters of the original request are included in the redirect request when the system runs the redirection rule or mirroring-based back-to-origin rule. If the PassQueryString parameter is set to true and "?a=b&c=d" is included in a request sent to OSS, this parameter is added to the Location header when the redirection mode is 302. For example, if the request contains "Location: www.example.com?a=b&c=d" and the value of RedirectType is Mirror, the a=b&c=d parameter is included in the back-to-origin request. Default value: false Parent nodes: Redirect
  MirrorURL	String	http://example.com	The origin URL for mirroring-based back-to-origin. This element takes effect only when the value of RedirectType is Mirror. The origin URL must start with http:// or https:// and end with a forward slash (/). OSS adds an object name to the end of the URL to generate a back-to-origin URL. For example, the name of the object to access is myobject. If MirrorURL is set to http://example.com/, the back-to-origin URL is http://example.com/myobject. If MirrorURL is set to http://example.com/dir1/, the back-to-origin URL is http://example.com/dir1/myobject. Parent nodes: Redirect
  MirrorPassQueryString	Boolean	false	This element plays the same role as PassQueryString and has a higher priority than PassQueryString. This element takes effect only when the value of RedirectType is Mirror. Default value: false Parent nodes: Redirect
  MirrorFollowRedirect	Boolean	true	Indicates whether the access is redirected to the address specified by Location if the origin returns a 3xx HTTP status code. This element takes effect only when the value of RedirectType is Mirror. For example, when a mirroring-based back-to-origin request is initiated, the origin returns 302 and Location is specified. true: OSS continues to request the address specified by Location. The access can be redirected up to 10 times. After 10 times, an error message is returned. false: OSS returns 302 and passes through Location. Default value: true Parent nodes: Redirect
  MirrorCheckMd5	Boolean	false	Indicates whether OSS checks the MD5 hash of the body of the response returned by the origin. This element takes effect only when the value of RedirectType is Mirror. When the value of this parameter is true and the response returned by the origin includes the Content-Md5 header, OSS checks whether the MD5 hash of the obtained data matches the header value. If the MD5 hash of the obtained data does not match the header value, OSS does not store the data. Default value: false Parent nodes: Redirect
  MirrorHeaders	Container	N/A	The headers that are included when a mirroring-based back-to-origin rule is specified for the bucket. This element takes effect only when the value of RedirectType is Mirror. Parent nodes: Redirect
  PassAll	Boolean	true	Indicates whether OSS passes through all request headers to the origin. The request headers exclude reserved headers and headers that start with oss-, x-oss-, and x-drs-. This element takes effect only when the value of RedirectType is Mirror. Default value: false Parent nodes: MirrorHeaders
  Pass	String	myheader-key1	The header to pass through to the origin. This element takes effect only when the value of RedirectType is Mirror. The header can be up to 1,024 bytes in length and can contain only letters, digits, and hyphens (-). You can specify up to 10 Pass headers. Parent nodes: MirrorHeaders
  Remove	String	myheader-key3	The header that is not allowed to pass through to the origin. Up to 10 Remove headers can be specified. This element is used together with PassAll. The header can be up to 1,024 bytes in length. The character set of this parameter is the same as that of Pass. This element takes effect only when the value of RedirectType is Mirror. Parent nodes: MirrorHeaders
  Set	Container	N/A	Indicates the headers that are sent to the origin. The specified headers are configured in the data returned by the origin regardless of whether the headers are contained in the request. Up to 10 Set containers can be specified. This element takes effect only when the value of RedirectType is Mirror. Parent nodes: MirrorHeaders
  Key	String	myheader-key5	The key of the header. The key can be up to 1,024 bytes in length. The character set of this parameter is the same as that of Pass. This element takes effect only when the value of RedirectType is Mirror. Parent nodes: Set
  Value	String	myheader-value5	The value of the header. The value can be up to 1,024 bytes in length and cannot contain "\r\n". This element takes effect only when the value of RedirectType is Mirror. Parent nodes: Set
  Protocol	String	http	The protocol used to redirect the access. This element takes effect only when the value of RedirectType is External or AliCDN. For example, if you access an object named test, Protocol is set to https, and Hostname is set to example.com, the Location header value is https://example.com/test. Valid values: http and https. Parent nodes: Redirect
  HostName	String	example.com	The domain name used for redirection, which must comply with the naming conventions for domain names. This element takes effect only when the value of RedirectType is External or AliCDN. For example, if you access the object named test, Protocol is set to https, and Hostname is set to example.com, the Location header is https://www.example.com/test. Parent nodes: Redirect
  HttpRedirectCode	HTTP status code	301	The HTTP redirect code in the response. This element takes effect only when the value of RedirectType is External or AliCDN. Valid values: 301, 302, and 307 Parent nodes: Redirect
  ReplaceKeyPrefixWith	String	def/	The string used to replace the prefix of the object name in the redirect request. This element takes effect only when the value of RedirectType is External or AliCDN. For example, if you access an object named abc/test.txt and ReplaceKeyPrefixWith is set to def/, the value of the Location header varies based on whether the value of KeyPrefixEquals is empty. If the value of KeyPrefixEquals is set to abc/, the Location header value is http://example.com/def/test.txt. If KeyPrefixEquals is empty, the Location header value is http://example.com/def/abc/test.txt. Parent nodes: Redirect
  ReplaceKeyWith	String	prefix/${key}.suffix	The string used to replace the object name in the redirect request. This element takes effect only when the value of RedirectType is External or AliCDN. This element supports the ${key} variable, which indicates the object name in the request. For example, if you access an object named test and ReplaceKeyWith is set to prefix/${key}.suffix, the Location header value is http://example.com/prefix/test.suffix. Parent nodes: Redirect

Examples

Get /?website HTTP/1.1
Host: oss-example.oss-cn-hangzhou.aliyuncs.com   
Date: Thu, 13 Sep 2012 07:51:28 GMT
Authorization: OSS qn6q**************:77Dv****************         

A complete sample response

GET /?website HTTP/1.1
Date: Fri, 27 Jul 2018 09:07:41 GMT
Host: test.oss-cn-hangzhou-internal.aliyuncs.com
Authorization: OSS qn6q**************:77Dv****************
User-Agent: aliyun-sdk-python-test/0.4.0


<?xml version="1.0" encoding="UTF-8"?>
<WebsiteConfiguration>
  <IndexDocument>
    <Suffix>index.html</Suffix>
  </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>  
        <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>
        <IncludeHeader>
          <Key>host</Key>
          <Equals>test.oss-cn-beijing-internal.aliyuncs.com</Equals>
        </IncludeHeader>
        <KeyPrefixEquals>abc/</KeyPrefixEquals>
        <HttpErrorCodeReturnedEquals>404</HttpErrorCodeReturnedEquals>
      </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>
  </RoutingRules>
</WebsiteConfiguration>

HTTP/1.1 200 OK
Server: AliyunOSS
Date: Fri, 27 Jul 2018 09:07:41 GMT
Content-Type: application/xml
Content-Length: 2102
Connection: keep-alive
x-oss-request-id: 5B5AE0DD2F7938C45FCED4BA
x-oss-server-time: 47

OSS SDKs

You can use OSS SDKs for the following programming languages to call the GetBucketWebsite operation:

• Java

• Python

• PHP

• Go V2

• C++

• C

• .NET

• Node.js

• Ruby

ossutil

For information about the ossutil command that corresponds to the GetBucketWebsite operation, see get-bucket-website.

Error codes