Overview

This document provides an overview of APIs and SDK code samples related to static website.

Setting Static Website

Feature description

This API (PUT Bucket website) is used to configure a static website for a bucket.

Method prototype

func (s *BucketService) PutWebsite(ctx context.Context, opt *BucketPutWebsiteOptions) (*Response, error)

Sample request

opt := &cos.BucketPutWebsiteOptions{
    Index: "index.html",
    Error: &cos.ErrorDocument{"index_backup.html"},
    RoutingRules: &cos.WebsiteRoutingRules{
        []cos.WebsiteRoutingRule{
        {   
            ConditionErrorCode: "404",
            RedirectProtocol:   "https",
            RedirectReplaceKey: "404.html",
        },  
        {   
            ConditionPrefix:          "docs/",
            RedirectProtocol:         "https",
            RedirectReplaceKeyPrefix: "documents/",
        },  
        },  
    },  
}   
resp, err := client.Bucket.PutWebsite(context.Background(), opt)

Parameter description

type WebsiteRoutingRule struct {
    ConditionErrorCode string 
    ConditionPrefix    string 

    RedirectProtocol         string 
    RedirectReplaceKey       string 
    RedirectReplaceKeyPrefix string 
}

type WebsiteRoutingRules struct {
    Rules []WebsiteRoutingRule
}

type ErrorDocument struct {
    Key string 
}

type RedirectRequestsProtocol struct {
    Protocol string 
}

type BucketPutWebsiteOptions struct {
    XMLName          xml.Name                  
    Index            string                    
    RedirectProtocol *RedirectRequestsProtocol
    Error            *ErrorDocument            
    RoutingRules     *WebsiteRoutingRules
}

Querying Static Website Configuration

Feature description

This API (GET Bucket website) is used to query the configuration information of a static website associated with a bucket.

Method prototype

func (s *BucketService) GetWebsite(ctx context.Context) (*BucketGetWebsiteResult, *Response, error)

Sample request

res, rsp, err := client.Bucket.GetWebsite(context.Background())

Returned result description

type BucketGetWebsiteResult BucketPutWebsiteOptions

Deleting Static Website Configuration

Feature description

This API (DELETE Bucket website) is used to delete the static website configuration of a bucket.

Method prototype

func (s *BucketService) DeleteWebsite(ctx context.Context) (*Response, error)

Sample request

resp, err = s.Client.Bucket.DeleteWebsite(context.Background())