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

Static Website

PDF
Focus Mode
Font Size
Last updated: 2024-02-04 14:25:57
This document provides an overview of APIs and SDK code samples related to static website.
API
Operation
Description
Setting a static website configuration
Configures a static website for a bucket
Querying a static website configuration
Queries the static website configuration of a bucket
Deleting a static website configuration
Deletes the static website configuration of a bucket

Setting Static Website Configuration

Description

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

Method prototype

public Guzzle\\Service\\Resource\\Model PutBucketWebsite(array $args = array());

Sample request

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.tencentcloud.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.tencentcloud.com/cam/capi
$region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.tencentcloud.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
array(
'region' => $region,
'schema' => 'https', // Protocol header, which is http by default
'credentials'=> array(
'secretId' => $secretId ,
'secretKey' => $secretKey)));

try {
$result = $cosClient->putBucketWebsite(array(
'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket
'IndexDocument' => array(
'Suffix' => 'index.html',
),
'RedirectAllRequestsTo' => array(
'Protocol' => 'https',
),
'ErrorDocument' => array(
'Key' => 'Error.html',
),
'RoutingRules' => array(
array(
'Condition' => array(
'HttpErrorCodeReturnedEquals' => '405',
),
'Redirect' => array(
'Protocol' => 'https',
'ReplaceKeyWith' => '404.html',
),
),
// ... repeated
),
));
// Request succeeded
print_r($result);
} catch (\\Exception $e) {
// Request failed
echo "$e\\n";
}

Parameter description

Parameter
Parent Node
Description
Type
Required
Bucket
None
Bucket for which a static website is configured, in the format of BucketName-APPID. For more information, please see Bucket Naming Conventions.
String
Yes
IndexDocument
None
Index document
Array
Yes
Suffix
IndexDocument
Index document suffix
String
Yes
ErrorDocument
None
Error document
Array
Yes
Key
ErrorDocument
Common error response
String
No
RedirectAllRequestsTo
None
Redirect all requests
Array
No
Protocol
RedirectAllRequestsTo
Site-wide redirect protocol. Only HTTPS is supported.
String
No
RoutingRules
None
Multiple redirect rules. Up to 100 redirect rules can be set.
Array
No
RoutingRule
RoutingRules
A single redirect rule. Redirects can be applied based on both prefix match and error codes.
Array
No
Condition
RoutingRule
Condition that must be met for a redirect to apply. Redirects can be applied based on either prefix match or error codes.
Array
No
HttpErrorCodeReturnedEquals
Condition
Redirect error code. Only 4xx status codes are supported. This has a higher priority than ErrorDocument.
Integer
No
KeyPrefixEquals
Condition
Object key prefix to replace with the specified "folder/" for the redirect.
String
No
Redirect
RoutingRule
Replacement rule for redirects that meet the condition.
Array
No
ReplaceKeyWith
Redirect
Content that is used to replace the entire key.
String
No
ReplaceKeyPrefixWith
Redirect
Content that is used to replace the key prefix. The replacement is allowed only when Condition is KeyPrefixEquals.
String
No

Querying Static Website Configuration

Description

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

Method prototype

public Guzzle\\Service\\Resource\\Model GetBucketWebsite(array $args = array());

Sample request

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.tencentcloud.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.tencentcloud.com/cam/capi
$region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.tencentcloud.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
array(
'region' => $region,
'schema' => 'https', // Protocol header, which is http by default
'credentials'=> array(
'secretId' => $secretId ,
'secretKey' => $secretKey)));

try {
$result = $cosClient->getBucketWebsite(array(
'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket
));
// Request succeeded
print_r($result);
} catch (\\Exception $e) {
// Request failed
echo "$e\\n";
}

Parameter description

Parameter
Description
Type
bucket
Bucket for which static website configuration is queried, in the format of BucketName-APPID. For more information, please see Bucket Naming Conventions.
String

Sample response

GuzzleHttp\\Command\\Result Object
(
[RedirectAllRequestsTo] => Array
(
[Protocol] => https
)

[IndexDocument] => Array
(
[Suffix] => index.html
)

[ErrorDocument] => Array
(
[Key] => Error.html
)

[RoutingRules] => Array
(
[0] => Array
(
[Condition] => Array
(
[HttpErrorCodeReturnedEquals] => 405
)

[Redirect] => Array
(
[Protocol] => https
[ReplaceKeyWith] => 404.html
)

)

)
[RequestId] => NWRmMzQ3YjlfMTlhYTk0MGFfNzMzYl84YWIy****
)

Response description

Parameter
Description
Type
Bucket
Bucket name in the format of BucketName-APPID. For more information, please see Bucket Naming Conventions.
String
IndexDocument
Index document
Array
Suffix
Index document suffix
String
ErrorDocument
Error document
Array
Key
Common error response
String
RedirectAllRequestsTo
Redirect all requests
Array
Protocol
Site-wide redirect protocol. Only HTTPS is supported.
String
RoutingRules
Multiple redirect rules. Up to 100 redirect rules can be set.
Array
RoutingRule
A single redirect rule. Redirects can be applied based on both prefix match and error codes.
Array
Condition
Condition that must be met for a redirect to apply. Redirects can be applied based on either prefix match or error codes.
Array
HttpErrorCodeReturnedEquals
Redirect error code. Only 4xx status codes are supported. This has a higher priority than ErrorDocument. ErrorDocument
Integer
KeyPrefixEquals
Object key prefix to replace with the specified "folder/" for the redirect.
String
Redirect
Replacement rule for redirects that meet the condition.
Array
ReplaceKeyWith
Content that is used to replace the entire key.
String
ReplaceKeyPrefixWith
Content that is used to replace the key prefix. The replacement is allowed only when Condition is KeyPrefixEquals.
String

Deleting Static Website Configuration

Description

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

Method prototype

public Guzzle\\Service\\Resource\\Model DeleteBucketWebsite(array $args = array());

Sample request

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.tencentcloud.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.tencentcloud.com/cam/capi
$region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.tencentcloud.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
array(
'region' => $region,
'schema' => 'https', // Protocol header, which is http by default
'credentials'=> array(
'secretId' => $secretId ,
'secretKey' => $secretKey)));

try {
$result = $cosClient->deleteBucketWebsite(array(
'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket
));
// Request succeeded
print_r($result);
} catch (\\Exception $e) {
// Request failed
echo "$e\\n";
}

Parameter description

Parameter
Description
Type
bucket
Bucket from which static website configuration is deleted, in the format of BucketName-APPID. For more information, please see Bucket Naming Convention
String


Help and Support

Was this page helpful?

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

Feedback