Feature description

You can use the PutBucketWebsite interface to set the bucket to static website hosting mode and configure redirect rules. This mode supports the following functions:

Redirect all requests to another site.

Set specific rules to redirect particular requests.

Notes

You must be the bucket owner or have PutBucketWebsite permission for the current bucket to call this interface.

You can set up to 50 redirect rules.

You must configure a custom domain before static website hosting mode takes effect.

Request syntax

Request parameters and headers

This request uses common request headers. See Common Parameters.

Name	Location	Type	Required	Sample value	Note
website	Query	String	Yes	-	Represents a special identifier for the PutBucketWebsite request.

Request body elements

Redirect all requests

Name	Type	Required	Sample value	Note
RedirectAllRequestsTo	Object	No	-	Redirect all requests. Once set, no other redirect rules can be applied.
HostName	String	Required if using RedirectAllRequestsTo	example.com	Redirected site name. Parent node: RedirectAllRequestsTo
Protocol	String	No	http	protocol used for redirect requests, supports http and https protocols. http protocol is used by default. parent node: RedirectAllRequestsTo

Redirect rules

Default home page IndexDocument

Name	Parameter type	Required	Sample value	Note
IndexDocument	Object	No	-	Set the default homepage.
Suffix	String	Required if using IndexDocument	index.html	When requesting a directory (ending with/), return the Suffix object under that directory. For example, if the Suffix is set to index.html, accessing document/ will return document/index.html. Parent node: IndexDocument
ForbiddenSubDir	Bool	No	false	whether to support redirecting to the default homepage of the subdirectory. the value descriptions are as follows: false (default): does not support redirecting to the default homepage of the subdirectory. true: supports redirecting to the default homepage of the subdirectory. parent node: IndexDocument

Error page ErrorDocument

Name	Type	Required	Sample value	Note
ErrorDocument	Object	No	-	Set the error page.
Key	String	If using ErrorDocument, it is required	error.html	If a 4xx error occurs, this page is returned. Parent node: ErrorDocument

Redirect rules RoutingRules

Name	Parameter type	Required	Sample value	Description
RoutingRules	Array	No	-	Set redirect rules.
Condition	Object	Required if RoutingRules is used	-	Set matching conditions for redirect rules. The redirect rules take effect only when all the set conditions match. Parent node: RoutingRules
HttpErrorCodeReturnedEquals	Integer	No	404	Set the HTTP error code for redirect activation. For example, set HttpErrorCodeReturnedEquals to 404. The rule takes effect when the specified object is not found. If KeyPrefixEquals is set, both conditions must match for the redirect rule to take effect. Parent node: Condition
KeyPrefixEquals	String	No	red/	set the object name prefix when the redirect rule takes effect. If HttpErrorCodeReturnedEquals is set, the redirect rule works only when both conditions match. Parent node: Condition
Redirect	Object	If using RoutingRules, it is required	-	Set redirect rules. Parent node: RoutingRules
HostName	String	No	example.com	Set the site name for redirection. Parent node: Redirect
HttpRedirectCode	Integer	No	301	Status code returned when redirecting; only 3XX error codes can be set, 300 is not allowed, default is 301. Parent node: Redirect
Protocol	String	No	http	The protocol used for redirect requests; supports http and https protocols. http protocol is used by default. Parent node: Redirect
ReplaceKeyPrefixWith	String	No	redirect/	Prefix for the object name used during redirection. Cannot be set simultaneously with ReplaceKeyWith. Parent node: Redirect
ReplaceKeyWith	String	No	redirect.html	The object name used during redirection. Cannot be set simultaneously with ReplaceKeyPrefixWith. Parent node: Redirect

Response headers

This request returns public response headers. See common parameters.

Response body elements

No elements are used in this response.

Sample request 1

Sample response 1

Sample request 2

Sample response 2

Torch Object Storage