Obtaining Static Website Hosting Configurations (SDK for Node.js)

Updated on 2025-02-07 GMT+08:00

View PDF

NOTICE:

If you have any questions during development, post them on the Issues page of GitHub.

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

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

Restrictions

To obtain the static website hosting configurations 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 Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.
To learn about the mappings between OBS regions and endpoints, see Regions and Endpoints.

Method

ObsClient.getBucketWebsite(params)

Request Parameters

**Table 1** BucketRequestInput
Parameter	Type	Mandatory (Yes/No)	Description
Bucket	string	Yes	Explanation: Bucket name. Restrictions: A bucket name must be unique across all accounts and regions. A bucket name: Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed. Cannot be formatted as an IP address. Cannot start or end with a hyphen (-) or period (.). Cannot contain two consecutive periods (..), for example, my..bucket. Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket. If you repeatedly create buckets with the same name in the same region, no error will be reported, and the bucket attributes comply with those set in the first creation request. Value range: The value can contain 3 to 63 characters. Default value: None

Responses

**Table 2** Responses
Type	Description
Table 3 NOTE: This API returns a Promise response, which requires the Promise or async/await syntax.	Explanation: Returned results. For details, see Table 3.

**Table 3** Response
Parameter	Type	Description
CommonMsg	ICommonMsg	Explanation: Common information generated after an API call is complete, including the HTTP status code and error code. For details, see Table 4.
InterfaceResult	Table 5	Explanation: Results outputted for a successful call. For details, see Table 5. Restrictions: This parameter is not included if the value of Status is greater than 300.

**Table 4** ICommonMsg
Parameter	Type	Description
Status	number	Explanation: HTTP status code returned by the OBS server. Value range: A status code is a group of digits indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors). For details, see Status Codes.
Code	string	Explanation: Error code returned by the OBS server.
Message	string	Explanation: Error description returned by the OBS server.
HostId	string	Explanation: Request server ID returned by the OBS server.
RequestId	string	Explanation: Request ID returned by the OBS server.
Id2	string	Explanation: Request ID2 returned by the OBS server.
Indicator	string	Explanation: Error code details returned by the OBS server.

**Table 5** GetBucketWebsiteOutput
Parameter	Type	Description
RequestId	string	Explanation: Request ID returned by the OBS server
RedirectAllRequestsTo	RedirectAllRequestTo	Explanation: Redirection rules for all requests. For details, see Table 8.
IndexDocument	IndexDocument	Explanation: Default page configuration. For details, see Table 6.
ErrorDocument	ErrorDocument	Explanation: Error page configuration. For details, see Table 7.
RoutingRules	RoutingRule[]	Explanation: List of routing rules. For details, see Table 9.

**Table 6** IndexDocument
Parameter	Type	Mandatory (Yes/No)	Description
Suffix	string	Yes if IndexDocument is specified	Explanation: Suffix that is appended to the request for a directory. For example, if the suffix is index.html and you request samplebucket/images/, the returned data will be for the object named images/index.html in the bucket samplebucket. Restrictions: This parameter can neither be left blank nor contain slashes (/). Value range: None Default value: None

**Table 7** ErrorDocument
Parameter	Type	Mandatory (Yes/No)	Description
Key	string	No if ErrorDocument is specified	Explanation: The object name that is used when a 4XX error occurs. This element specifies the page that is returned when an error occurs. Restrictions: None Value range: The key can contain 1 to 1,024 characters. Default value: None

**Table 8** RedirectAllRequestsTo
Parameter	Type	Description
HostName	string	Explanation: Domain name used for redirection, for example, www.example.com
Protocol	string	Explanation: Protocol used for redirection

**Table 9** RoutingRule
Parameter	Type	Description
Condition	Condition	Explanation: Conditions that must be met for the specified rule to take effect. For details, see Condition.
Redirect	Redirect	Explanation: Details about the redirection. For details, see Table 11.

**Table 10** Condition
Parameter	Type	Mandatory (Yes/No)	Description
KeyPrefixEquals	string	No	Explanation: Object name prefix for the redirection to take effect. If the name prefix of the requested object is the same as the value specified for this parameter, the redirection rule takes effect. For example, to redirect the requests for the object ExamplePage.html, set KeyPrefixEquals to ExamplePage.html. Restrictions: This parameter cannot be used together with HttpErrorCodeReturnedEquals. Value range: The value can contain 1 to 1,024 characters. Default value: None
HttpErrorCodeReturnedEquals	string	No	Explanation: HTTP error code for the redirection to take effect. If an error code returned is the same as the value specified for this parameter, the redirection rule takes effect. For example, if you want to redirect requests to NotFound.html when HTTP error code 404 is returned, set HttpErrorCodeReturnedEquals to 404 in Condition and set ReplaceKeyWith to NotFound.html in Redirect. Restrictions: This parameter cannot be used together with KeyPrefixEquals. Value range: See Error Codes. Default value: None

**Table 11** Redirect
Parameter	Type	Description
Protocol	string	Explanation: Protocol used for redirection
HostName	string	Explanation: Domain name used for redirection
ReplaceKeyPrefixWith	string	Explanation: Object name prefix used in the redirection request
ReplaceKeyWith	string	Explanation: Object name used in the redirection request
HttpRedirectCode	string	Explanation: HTTP status code in the response to the redirection request. For details, see Status Codes.

Code Examples

You can call ObsClient.getBucketWebsite to obtain the hosting configuration of a bucket. The following code shows how to obtain the website configuration of bucket examplebucket:

    
     
       
       // Import the OBS library.
// Use npm to install the client.
const ObsClient = require("esdk-obs-nodejs");
// Use the source code to install the client.
// var ObsClient = require('./lib/obs');

// Create an instance of ObsClient.
const obsClient = new ObsClient({
  // Obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways. Using hard coding may result in leakage.
  // Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
  access_key_id: process.env.ACCESS_KEY_ID,
  secret_access_key: process.env.SECRET_ACCESS_KEY,
  // (Optional) If you use a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding, which may result in information leakage. You can obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways.
  // security_token: process.env.SECURITY_TOKEN,
  // Enter the endpoint corresponding to the region where the bucket is located. CN-Hong Kong is used here in this example. Replace it with the one currently in use.
  server: "https://obs.ap-southeast-1.myhuaweicloud.com"
});

async function getBucketWebsite() {
  try {
    const params = {
      // Specify the bucket name.
      Bucket: "examplebucket",
    };
    // Obtain the website configuration of the bucket.
    const result = await obsClient.getBucketWebsite(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Get bucket(%s)'s website configuration successful!", params.Bucket);
      console.log('RedirectAllRequestsTo:');
      console.log('HostName: %s', result.InterfaceResult.RedirectAllRequestsTo.HostName);
      console.log('Protocol: %s', result.InterfaceResult.RedirectAllRequestsTo.Protocol);
      console.log('IndexDocument[Suffix]: %s', result.InterfaceResult.IndexDocument.Suffix);
      console.log('ErrorDocument[Key]: %s', result.InterfaceResult.ErrorDocument.Key);
      console.log('RoutingRules:');
      for (let i = 0; i < result.InterfaceResult.RoutingRules; i++) {
        let routingRule = result.InterfaceResult.RoutingRules[i];
        let condition = routingRule.Condition;
        console.log("Condition[%d]-KeyPrefixEquals:%s, HttpErrorCodeReturnedEquals:%s",
          i, condition.KeyPrefixEquals, condition.HttpErrorCodeReturnedEquals
        );
        let redirect = routingRule.Redirect;
        console.log("Redirect[%d]-Protocol:%s, HostName:%s, ReplaceKeyPrefixWith:%s, HttpRedirectCode:%s",
          i, redirect.Protocol, redirect.HostName, redirect.ReplaceKeyPrefixWith, redirect.HttpRedirectCode
        );
      };
      return;
    };
    
    console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
    console.log("Status: %d", result.CommonMsg.Status);
    console.log("Code: %s", result.CommonMsg.Code);
    console.log("Message: %s", result.CommonMsg.Message);
    console.log("RequestId: %s", result.CommonMsg.RequestId);
  } catch (error) {
    console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.");
    console.log(error);
  };
};

getBucketWebsite();

      

    
   