Updated on 2026-09-20 GMT+08:00

Obtaining the Static Website Hosting Configuration of a Bucket

Function

You can host static website resources such as HTML web pages, flash files, or audio and video files in an OBS bucket, so that you can provide these hosted resources using the bucket's website endpoint to end users. Typical use cases include:

Redirecting all requests to another website
Redirecting specific requests to another website

This API returns the static website hosting configurations of the bucket.

Constraints

To obtain the static website hosting configuration of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetBucketWebsite in IAM or GetBucketWebsite in a bucket policy). For details, see Differences Between OBS Permissions Control Methods, Using IAM Roles or Policies to Grant Access to OBS, and Creating a Custom Bucket Policy.

Command Line Structure

Windows

obsutil website obs://bucket -method=get [-localfile=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]

macOS or Linux

./obsutil website obs://bucket -method=get [-localfile=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]

Examples

Take the Windows OS as an example. Run obsutil website obs://test-bucket -method=get -localfile=d:\temp\website-output.xml to export the static website hosting configuration of bucket bucket to the local file website-output.xml.

obsutil website obs://test-bucket -method=get d:-localfile=d:\temp\website-output.xml

Start at 2024-09-30 07:59:28.8675681 +0000 UTC

Get website configuration succeed for bucket [test-bucket], requestId is [000001996F7948864011551B4FC8E0CA]

Parameter Description

Parameter	Optional or Mandatory	Description
bucket	Mandatory	The bucket name
method	Mandatory	The method. Set this parameter to get when obtaining the static website hosting configuration of a bucket.
localfile	Mandatory	The local file to which the static website hosting configuration is exported. If this parameter is not specified, the configuration defaults to standard output.
config	Optional (additional parameter)	The user-defined configuration file for executing the current command. For details about parameters that can be configured, see Configuration Parameters.
e	Optional (additional parameter)	The endpoint
i	Optional (additional parameter)	The user's AK
k	Optional (additional parameter)	The user's SK
t	Optional (additional parameter)	The user's security token

Helpful Links

For details about the API for obtaining the static website hosting configuration of a bucket, see Obtaining the Static Website Hosting Configuration of a Bucket.
For details about the meanings, causes, and handling methods of error codes that may be returned during the operation, see OBS Error Codes.
For the FAQ about static website hosting, see Static Website Hosting FAQ.

Parent topic: Static Website Hosting