Cloud Object Storage
- Release Notes and Announcements
- Announcements
- Product Introduction
- Purchase Guide
- Billing Method
- Billable Items
- Metadata Acceleration Fees
- Data Processing Fees
- Getting Started
- Console Guide
- Bucket Management
- Domain Name Management
- Object Management
- Folder Management
- Monitoring Reports
- Data Processing
- Image Processing
- File Processing
- Media Processing
- Function Service
- Content Moderation
- Automatic Moderation
- Historical data moderation
- Data Processing Workflow
- User Tools
- COSBrowser
- COSCLI (Beta)
- Common Commands
- Online Auxiliary Tools
- Practical Tutorial
- Access Control and Permission Management
- Performance Optimization
- Data Migration
- Data Disaster Recovery and Backup
- Domain Name Management Practice
- Image Processing
- Audio/Video Practices
- Direct Data Upload
- Content Moderation
- Data Verification
- Big Data Practice
- Using COS in the Third-party Applications
- Developer Guide
- Creating Request
- Object
- Uploading Object
- Downloading Object
- Copying Objects
- Deleting Objects
- Data Management
- Lifecycle Management
- Data Disaster Recovery
- Versioning
- Using Versioning
- Cross-Bucket Replication
- Data Security
- Cloud Access Management
- Access Permission Configuration Description
- Access Control Overview
- Access Control Methods
- Access Policy Language
- Using CDN to Accelerate Access
- Batch Operation
- Performing Batch Operation
- Global Acceleration
- Data Workflow
- Data Lake Storage
- Cloud Native Datalake Storage
- Metadata Accelerator
- Big Data Security
- GooseFS
- Key Features
- Deployment Guide
- OPS Guide
- Logging Guide
- Data Processing
- Image Processing
- Media Processing
- Troubleshooting
- Resource Access Error
- API Documentation
- Service APIs
- Bucket APIs
- Basic Operations
- Access Control List (acl)
- Cross-Origin Resource Sharing (cors)
- Bucket Policy (policy)
- Hotlink Protection (referer)
- Static Website (website)
- Intelligent Tiering
- Bucket inventory(inventory)
- Cross-Bucket Replication（replication）
- Log Management(logging)
- Global Acceleration (Accelerate)
- Bucket Encryption (encryption)
- Custom Domain Name (Domain)
- Origin-Pull (Origin)
- Object APIs
- Basic Operations
- Access Control List (acl)
- Multipart Upload
- Batch Operation APIs
- Data Processing APIs
- Image Processing
- Basic Image Processing
- AI-Based Content Recognition
- Queue APIs
- Service Configuration
- Media Processing
- Media Screenshot API
- Media Information API
- Private M3U8 API
- File Processing
- File Transcoding
- Async Processing Job APIs
- Async Processing Queue APIs
- File Processing
- Hash Calculation
- File Decompression
- Multi-File Zipping
- Job and Workflow
- Workflow APIs
- Workflow Instance
- Job APIs
- Media Processing
- Canceling Media Processing Job
- Querying Media Processing Job
- Media Processing Job Callback
- Image Processing
- Submit Image Processing Job
- Canceling Image Processing Job
- Querying Image Processing Job
- Multi-Job Processing
- Submitting Multiple Jobs
- AI-Based Content Recognition
- Submitting Content Recognition Job
- Querying Content Recognition Job
- Content Recognition Job Callback
- Sync Media Processing
- Media Screenshot API
- Template APIs
- Media Processing
- Creating Media Processing Template
- Deleting Media Processing Template
- Querying Media Processing Template
- Updating Media Processing Template
- AI-Based Content Recognition
- Creating AI-Based Content Recognition Template
- Querying AI-Based Content Recognition Template
- Updating AI-Based Content Recognition Template
- Batch Job APIs
- Callback Content
- Appendix
- Content Moderation APIs
- Image Moderation
- Video Moderation
- Audio Moderation
- Text Moderation
- Submitting Virus Detection Job
- SDK Documentation
- Android SDK
- Object Operations
- Remote Disaster Recovery
- Cloud Access Management
- Data Verification
- Image Processing
- C SDK
- Object Operations
- Data Management
- Cloud Access Management
- Content Moderation
- Data Verification
- C++ SDK
- Cross-Region Disaster Recovery
- Data Management
- Cloud Access Management
- Data Verification
- Content Moderation
- .NET(C#) SDK
- Bucket Operations
- Object Operations
- Cross-Region Disaster Recovery
- Cloud Access Management
- Image Processing
- SDK for Flutter
- Object Operations
- Go SDK
- Bucket Operations
- Object Operations
- Cross-Region Disaster Recovery
- Cloud Access Management
- Data Verification
- File Processing
- Image Processing
- iOS SDK
- Object Operations
- Cross-region Disaster Recovery
- Cloud Access Management
- Image Processing
- Content Recognition
- Speech Recognition
- Java SDK
- Object Operations
- Cross-Region Disaster Recovery
- Cloud Access Management
- File Processing
- Media Processing
- AI-Based Content Recognition
- JavaScript SDK
- Object Operations
- File Processing
- Remote disaster-tolerant
- Data Management
- Cloud Access Management
- Data Verification
- Image Processing
- Node.js SDK
- Object Operations
- Remote disaster-tolerant
- Cloud Access Management
- Data Verification
- Image Processing
- PHP SDK
- Object Operations
- Bucket Operations
- Remote disaster-tolerant
- Cloud Access Management
- Image Processing
- Media Processing
- Document Processing
- File Processing
- Job APIs
- Template APIs
- Python SDK
- Object Operations
- Server-Side Encryption
- Cross-Region Disaster Recovery
- Cloud Access Management
- Content Recognition
- React Native SDK
- Object Operations
- Mini Program SDK
- Object Operations
- Remote disaster-tolerant
- Cloud Access Management
- Data Verification
- Content Moderation
- Image Processing
- FAQs
- Bucket Configuration
- Domain Names and CDN
- Object Operations
- Data Processing
- Related Agreements
- Appendices
- Historical version
Static Website
Last updated: 2024-02-02 16:24:05
Overview
This document provides an overview of APIs and SDK code samples related to static website.
API | Operation Name | Operation Description |
Setting a static website | Sets static website configuration for a bucket | |
Querying static website configuration | Queries the static website configuration information of a bucket | |
Deleting static website configuration | Deletes the static website configuration of a bucket |
Setting Static Website
Feature description
This API (PUT Bucket website) is used to configure a static website for a bucket.
Method prototype
public void setBucketWebsiteConfiguration(String bucketName, BucketWebsiteConfiguration configuration)throws CosClientException, CosServiceException;public void setBucketWebsiteConfiguration(SetBucketWebsiteConfigurationRequest setBucketWebsiteConfigurationRequest)throws CosClientException, CosServiceException;
Sample request
String bucketName = "examplebucket-1250000000";// Set bucket websiteBucketWebsiteConfiguration bucketWebsiteConfiguration = new BucketWebsiteConfiguration();// Index filebucketWebsiteConfiguration.setIndexDocumentSuffix("index.html");// Routing ruleList<RoutingRule> routingRuleList = new ArrayList<RoutingRule>();RoutingRule routingRule = new RoutingRule();RoutingRuleCondition routingRuleCondition = new RoutingRuleCondition();routingRuleCondition.setHttpErrorCodeReturnedEquals("404");routingRule.setCondition(routingRuleCondition);RedirectRule redirectRule = new RedirectRule();redirectRule.setProtocol("https");redirectRule.setReplaceKeyPrefixWith("404.html");routingRule.setRedirect(redirectRule);routingRuleList.add(routingRule);bucketWebsiteConfiguration.setRoutingRules(routingRuleList);cosclient.setBucketWebsiteConfiguration(bucketName, bucketWebsiteConfiguration);
Parameter description
Parameter Name | Description | Type |
setBucketWebsiteConfigurationRequest | Request to set static website for bucket | SetBucketWebsiteConfigurationRequest |
Request member description:Request Member | Setting Method | Description | Type |
bucketName | Constructor or set method | Bucket for which to set a static website in the format of BucketName-APPID. For more information, please see Naming Convention | String |
configuration | Constructor or set method | Static website configuration of bucket | BucketWebsiteConfiguration |
BucketWebsiteConfiguration member description:Parameter Name | Description | Type |
indexDocumentSuffix | Index document | String |
errorDocument | Error document | String |
redirectAllRequestsTo | Configuration for redirecting all requests | RedirectRule |
routingRules | Sets redirect rules. Up to 100 RoutingRule can be set | List |
RoutingRule member description:Parameter Name | Description | Type |
condition | Specifies the condition for redirect. Either prefix match-triggered redirect or error code-triggered redirect can be specified at a time | RoutingRuleCondition |
redirect | Redirect rule | RedirectRule |
RoutingRuleCondition member description:Parameter Name | Description | Type |
keyPrefixEquals | Specifies the path for prefix-triggered redirect | RoutingRuleCondition |
httpErrorCodeReturnedEquals | Specifies error code for redirect | RedirectRule |
RedirectRule member description:Parameter Name | Description | Type |
protocol | Specifies the protocol for global redirect | String |
replaceKeyPrefixWith | Replaces the matched prefix with the specified content, which can be set only if Condition is KeyPrefixEquals | String |
replaceKeyWith | Replaces the entire Key with the specified content | String |
httpRedirectCode | Specifies the protocol for global redirect | String |
Returned result description
Success: no returned value.
Failure: an error (e.g., authentication failed) occurred and a
CosClientException or CosServiceException exception was thrown. For more information, please see Troubleshooting.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
public BucketWebsiteConfiguration getBucketWebsiteConfiguration(String bucketName)throws CosClientException, CosServiceException;
Sample request
String bucketName = "examplebucket-1250000000";BucketWebsiteConfiguration bucketWebsiteConfiguration = cosclient.getBucketWebsiteConfiguration(bucketName);
Parameter description
Parameter Name | Description | Type |
bucketName | Bucket for which to query static website configuration in the format of BucketName-APPID. For more information, please see Naming Convention | String |
Returned result description
Success:
BucketWebsiteConfiguration is returned, which contains the static website configuration information of the bucket.Failure: an error (e.g., authentication failed) occurred and a
CosClientException or CosServiceException exception was thrown. For more information, please see Troubleshooting.Deleting Static Website Configuration
Feature description
This API (DELETE Bucket website) is used to delete the static website configuration of a bucket.
Method prototype
public void deleteBucketWebsiteConfiguration(String bucketName) throws CosClientException, CosServiceException;
Sample request
String bucketName = "examplebucket-1250000000";cosclient.deleteBucketWebsiteConfiguration(bucketName);
Parameter description
Parameter Name | Description | Type |
bucketName | Bucket for which to delete static website configuration in the format of BucketName-APPID. For more information, please see Naming Convention | String |
Returned result description
Success: no returned value.
Failure: an error (e.g., authentication failed) occurred and a
CosClientException or CosServiceException exception was thrown. For more information, please see Troubleshooting.Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No