tencent cloud

Cloud Object Storage

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Features
Use Cases
Strengths
Concepts
Regions and Access Endpoints
Specifications and Limits
Service Regions and Service Providers
Billing
Billing Overview
Billing Method
Billable Items
Free Tier
Billing Examples
Viewing and Downloading Bill
Payment Overdue
FAQs
Getting Started
Console
Getting Started with COSBrowser
User Guide
Creating Request
Bucket
Object
Data Management
Batch Operation
Global Acceleration
Monitoring and Alarms
Operations Center
Data Processing
Content Moderation
Smart Toolbox
Data Processing Workflow
Application Integration
User Tools
Tool Overview
Installation and Configuration of Environment
COSBrowser
COSCLI (Beta)
COSCMD
COS Migration
FTP Server
Hadoop
COSDistCp
HDFS TO COS
GooseFS-Lite
Online Tools
Diagnostic Tool
Use Cases
Overview
Access Control and Permission Management
Performance Optimization
Accessing COS with AWS S3 SDK
Data Disaster Recovery and Backup
Domain Name Management Practice
Image Processing
Audio/Video Practices
Workflow
Direct Data Upload
Content Moderation
Data Security
Data Verification
Big Data Practice
COS Cost Optimization Solutions
Using COS in the Third-party Applications
Migration Guide
Migrating Local Data to COS
Migrating Data from Third-Party Cloud Storage Service to COS
Migrating Data from URL to COS
Migrating Data Within COS
Migrating Data Between HDFS and COS
Data Lake Storage
Cloud Native Datalake Storage
Metadata Accelerator
GooseFS
Data Processing
Data Processing Overview
Image Processing
Media Processing
Content Moderation
File Processing Service
File Preview
Troubleshooting
Obtaining RequestId
Slow Upload over Public Network
403 Error for COS Access
Resource Access Error
POST Object Common Exceptions
API Documentation
Introduction
Common Request Headers
Common Response Headers
Error Codes
Request Signature
Action List
Service APIs
Bucket APIs
Object APIs
Batch Operation APIs
Data Processing APIs
Job and Workflow
Content Moderation APIs
Cloud Antivirus API
SDK Documentation
SDK Overview
Preparations
Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Flutter SDK
Go SDK
iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
React Native SDK
Mini Program SDK
Error Codes
Harmony SDK
Endpoint SDK Quality Optimization
Security and Compliance
Data Disaster Recovery
Data Security
Cloud Access Management
FAQs
Popular Questions
General
Billing
Domain Name Compliance Issues
Bucket Configuration
Domain Names and CDN
Object Operations
Logging and Monitoring
Permission Management
Data Processing
Data Security
Pre-signed URL Issues
SDKs
Tools
APIs
Agreements
Service Level Agreement
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary
DocumentationCloud Object StorageSDK DocumentationNode.js SDK Data ManagementStatic Website

Static Website

PDF
Focus Mode
Font Size
Last updated: 2024-02-04 11:37:32

Overview

This document provides an overview of APIs and SDK code samples related to static websites.
API
Operation
Description
Setting a static website
Sets a static website configuration on an existing bucket
Querying a static website
Queries the static website configuration on a bucket
Deleting a static website
Deletes the static website configuration on a bucket

Setting a static website

Feature description

This API is used to configure a static website for an existing bucket.

Sample request

cos.putBucketWebsite({
    Bucket: 'examplebucket-1250000000',  /* Required */
    Region: 'ap-beijing',    /* Required */
    WebsiteConfiguration: {
        IndexDocument: {
            Suffix: "index.html"
        },
        ErrorDocument: {
            Key: "error.html"
        },
        RedirectAllRequestsTo: {
            Protocol: "https"
        },
    }
}, function(err, data) {
    console.log(err || data);
});

Parameter description

Parameter Name
Description
Type
Required
Bucket
Name of the bucket with a static website configuration in the format: BucketName-APPID
String
Yes
Region
Bucket region. For the enumerated values, see Regions and Access Domain Names
String
Yes
WebsiteConfiguration
Static website configuration, including index documents, error documents, protocol conversion, and redirect rules
Object
Yes
- IndexDocument
Index document
Object
Yes
- - Suffix
Specifies an index document
String
Yes
- ErrorDocument
Error document
Object
No
- - Key
Specifies general error responses
String
No
- RedirectAllRequestsTo
Redirects all requests
Object
No
- - Protocol
Specifies the site-wide redirect protocol, only HTTPS is supported.
String
No
- RoutingRules
Sets up to 100 redirect rules
ObjectArray
No
- - Condition
Specifies the condition that must be met for a redirect to apply; redirects can either be applied based on prefix-matching or error codes.
Object
No
- - - HttpErrorCodeReturnedEquals
Specifies the redirect error code. Only 4XX status codes are supported. This has a higher priority than ErrorDocument.
String
No
- - - KeyPrefixEquals
Specifies the prefix of the paths to be redirected
String
No
- - Redirect
Specifies the replacement rule for redirects that meet the condition
Object
No
- - - ReplaceKeyWith
Specifies the content that is used to replace the entire key
String
No
- - - ReplaceKeyPrefixWith
Specifies the content that is used to replace the key prefix. This is allowed only when the condition is KeyPrefixEquals.
String
No

Callback function description

function(err, data) { ... }
Parameter Name
Description
Type
err
Object returned when an error (network error or service error) occurs. If the request is successful, this is null. For more information, see Error Codes.
Object
- statusCode
HTTP status code returned by the request, such as 200, 403, and 404
Number
- headers
Header information returned by the request
Object
data
Data returned when the request is successful. If the request fails, this is null.
Object
- statusCode
HTTP status code returned by the request, such as 200, 403, and 404
Number
- headers
Header information returned by the request
Object

Querying a static website

Feature description

This API is used to query the static website configuration associated with a bucket.

Sample request

cos.getBucketWebsite({
    Bucket: 'examplebucket-1250000000',  /* Required */
    Region: 'ap-beijing',    /* Required */
}, function(err, data) {
    console.log(err || data);
});

Sample response

{
    "WebsiteConfiguration": {
        "IndexDocument": {
            "Suffix": "index.html"
        },
        "ErrorDocument": {
            "Key": "error.html"
        },
        "RedirectAllRequestsTo": {
            "Protocol": "https"
        },
    },
    "statusCode": 200,
    "headers": {}
}

Parameter description

Parameter Name
Description
Type
Required
Bucket
Name of the bucket with a static website configuration in the format: BucketName-APPID
String
Yes
Region
Bucket region. For the enumerated values, see Regions and Access Domain Names
String
Yes

Callback function description

function(err, data) { ... }
Parameter Name
Description
Type
err
Object returned when an error (network error or service error) occurs. If the request is successful, this is null. For more information, see Error Codes.
Object
- statusCode
HTTP status code returned by the request, such as 200, 403, and 404
Number
- headers
Header information returned by the request
Object
data
Data returned when the request is successful. If the request fails, this is null.
Object
- statusCode
HTTP status code returned by the request, such as 200, 403, and 404
Number
- headers
Header information returned by the request
Object
- WebsiteConfiguration
Static website configuration, including index documents, error documents, protocol conversion, and redirect rules
Object
- - IndexDocument
Index document
Object
- - - Suffix
Specifies an index document
String
- - ErrorDocument
Error document
Object
- - - Key
Specifies general error response
String
- - RedirectAllRequestsTo
Redirects all requests
Object
- - - Protocol
Specifies the site-wide redirect protocol, only HTTPS is supported.
String
- - RoutingRules
Sets up to 100 redirect rules
ObjectArray
- - - Condition
Specifies the condition that must be met for a redirect to apply; redirects can either be applied based on prefix-matching or error codes.
Object
- - - - HttpErrorCodeReturnedEquals
Specifies the redirect error code. Only 4XX status codes are supported. This has a higher priority than ErrorDocument.
String
- - - - KeyPrefixEquals
Specifies the prefix of the paths to be redirected
String
- - - Redirect
Specifies the replacement rule for redirects that meet the condition
Object
- - - - ReplaceKeyWith
Specifies the content that is used to replace the entire key
String
- - - - ReplaceKeyPrefixWith
Specifies the content that is used to replace the key prefix. This is allowed only when the condition is KeyPrefixEquals.
String

Deleting a static website

Feature description

This API is used to delete the static website configuration on a bucket.

Sample request

cos.deleteBucketWebsite({
    Bucket: 'examplebucket-1250000000',  /* Required */
    Region: 'ap-beijing',    /* Required */
}, function(err, data) {
    console.log(err || data);
});

Parameter description

Parameter Name
Description
Type
Required
Bucket
Name of the bucket whose static website configuration is deleted in the format: BucketName-APPID
String
Yes
Region
Bucket region. For the enumerated values, see Regions and Access Domain Names
String
Yes

Callback function description

function(err, data) { ... }
Parameter Name
Description
Type
err
Object returned when an error (network error or service error) occurs. If the request is successful, this is null. For more information, see Error Codes.
Object
- statusCode
HTTP status code returned by the request, such as 200, 403, and 404
Number
- headers
Header information returned by the request
Object
data
Data returned when the request is successful. If the request fails, this is null.
Object
- statusCode
HTTP status code returned by the request, such as 200, 403, and 404
Number
- headers
Header information returned by the request
Object

Previous Topic: Object TagNext Topic: Inventory

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback