tencent cloud

Cloud Object Storage

最新情報とお知らせ
製品アップデート情報
製品のお知らせ
製品概要
製品概要
機能概要
応用シナリオ
製品の優位性
基本概念
リージョンとアクセスドメイン名
仕様と制限
製品の課金
課金概要
課金方式
課金項目
無料利用枠
記帳例
請求書の確認とダウンロード
お支払い遅れについて
よくある質問
クイックスタート
コンソールクイックスタート
COSBrowserクイックスタート
ユーザーガイド
リクエストの作成
バケット
オブジェクト
データ管理
バッチ処理
グローバルアクセラレーション
監視とアラーム
運用管理センター
データ処理
インテリジェントツールボックス使用ガイド
データワークフロー
アプリ統合
ツールガイド
ツール概要
環境のインストールと設定
COSBrowserツール
COSCLIツール
COSCMDツール
COS Migrationツール
FTP Serverツール
Hadoopツール
COSDistCpツール
HDFS TO COSツール
オンラインツール (Onrain Tsūru)
セルフ診断ツール
実践チュートリアル
概要
アクセス制御と権限管理
パフォーマンスの最適化
AWS S3 SDKを使用したCOSアクセス
データディザスタリカバリバックアップ
ドメイン名管理の実践
画像処理の実践
COSオーディオビデオプレーヤーの実践
データセキュリティ
データ検証
COSコスト最適化ソリューション
サードパーティアプリケーションでのCOSの使用
移行ガイド
サードパーティクラウドストレージのデータをCOSへ移行
データレークストレージ
クラウドネイティブデータレイク
メタデータアクセラレーション
データアクセラレーター GooseFS
データ処理
データ処理概要
画像処理
メディア処理
コンテンツ審査
ファイル処理
ドキュメントプレビュー
トラブルシューティング
RequestId取得の操作ガイド
パブリックネットワーク経由でのCOSへのファイルアップロード速度の遅さ
COSへのアクセス時に403エラーコードが返される
リソースアクセス異常
POST Objectの一般的な異常
セキュリティとコンプライアンス
データ災害復帰
データセキュリティ
クラウドアクセスマネジメント
よくある質問
よくあるご質問
一般的な問題
従量課金に関するご質問
ドメインコンプライアンスに関するご質問
バケット設定に関する質問
ドメイン名とCDNに関するご質問
ファイル操作に関するご質問
権限管理に関するご質問
データ処理に関するご質問
データセキュリティに関するご質問
署名付きURLに関するご質問
SDKクラスに関するご質問
ツール類に関するご質問
APIクラスに関するご質問
Agreements
Service Level Agreement
プライバシーポリシー
データ処理とセキュリティ契約
連絡先
用語集
ドキュメントCloud Object Storage

PUT Bucket website

フォーカスモード
フォントサイズ
最終更新日: 2026-02-27 15:28:28

Overview

This API is used to configure a static website for a bucket by importing configuration files in XML format. The file size is limited to 64 KB.
Note:
If a bucket already has a static website configuration, calling this API will overwrite the existing static website configuration information.


Authorization Description

In the authorization policy, action is set to cos:PutBucketWebsite. View all action.

Request

Sample request

PUT /?website HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: GMT Date
Content-Type: application/xml
Content-Length: Content Length
Content-MD5: MD5
Authorization: Auth String

[Request Body]
Note:
In Host: <BucketName-APPID>.cos.<Region>.myqcloud.com, <BucketName-APPID> is the bucket name followed by the APPID, such as examplebucket-1250000000 (see Bucket Overview > Basic Information and Bucket Overview > Bucket Naming Conventions), and <Region> is a COS region (see Regions and Access Endpoints).
Authorization: Auth String (See Request Signature for details.)

Request parameters

This API has no request parameter.

Request headers

This API only uses Common Request Headers.

Request body

This request body submits the application/xml data that includes all information about the static website configuration of the bucket.
<WebsiteConfiguration>
    <IndexDocument>
        <Suffix>String</Suffix>
    </IndexDocument>
    <RedirectAllRequestsTo>
        <Protocol>String</Protocol>
    </RedirectAllRequestsTo>
    <AutoAddressing>
        <Status>Enabled|Disabled</Status>
    </AutoAddressing>
    <ErrorDocument>
        <Key>String</Key>
        <Charity404>Enabled|Disabled</Charity404>
        <OriginalHttpStatus>Enabled|Disabled</OriginalHttpStatus>
    </ErrorDocument>
    <RoutingRules>
        <RoutingRule>
            <Condition>
                <HttpErrorCodeReturnedEquals>Integer</HttpErrorCodeReturnedEquals>
            </Condition>
            <Redirect>
                <Protocol>String</Protocol>
                <ReplaceKeyWith>String</ReplaceKeyWith>
                <URLRedirect>Enabled|Disabled</URLRedirect>
            </Redirect>
        </RoutingRule>
        <RoutingRule>
            <Condition>
                <KeyPrefixEquals>String</KeyPrefixEquals>
            </Condition>
            <Redirect>
                <Protocol>String</Protocol>
                <ReplaceKeyPrefixWith>String</ReplaceKeyPrefixWith>
                <URLRedirect>Enabled|Disabled</URLRedirect>
            </Redirect>
        </RoutingRule>
    </RoutingRules>
</WebsiteConfiguration>
The nodes are described as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required
WebsiteConfiguration
None
Contains all the request information about PUT Bucket website
Container
Yes
Content of WebsiteConfiguration:
Node Name (Keyword)
Parent Node
Description
Type
Required
IndexDocument
WebsiteConfiguration
Index document configuration
Container
Yes
RedirectAllRequestsTo
WebsiteConfiguration
Configures redirection for all requests
Container
No
AutoAddressing
WebsiteConfiguration
Whether to ignore all file extensions
Container
No
ErrorDocument
WebsiteConfiguration
Error document configuration
Container
No
RoutingRules
WebsiteConfiguration
Routing rule configuration. A RoutingRules container can contain up to 100 RoutingRule elements.
Container
No
Content of IndexDocument:
Node Name (Keyword)
Parent Node
Description
Type
Required
Suffix
WebsiteConfiguration.IndexDocument
Specifies the object key suffix for index documents. For example, if it is specified as index.html, the request automatically returns index.html when you access the root directory of the bucket, or article/index.html when you access the directory article/.
String
Yes
Content of RedirectAllRequestsTo:
Node Name (Keyword)
Parent Node
Description
Type
Required
Protocol
WebsiteConfiguration.RedirectAllRequestsTo
Specifies the target protocol to redirect all requests. Only HTTPS is supported.
String
No
Content of AutoAddressing:
Node Name (Keyword)
Parent Node
Description
Type
Required
Status
WebsiteConfiguration.AutoAddressing
Whether to ignore the HTML file extension. Valid values: Enabled, Disabled (default)
String
No
Content of ErrorDocument:
Node Name (Keyword)
Parent Node
Description
Type
Required
Key
WebsiteConfiguration.ErrorDocument
Specifies the object key to return for the error document if an error occurs and does not match the error code in the routing rule
String
No
OriginalHttpStatus
WebsiteConfiguration.ErrorDocument
Configures whether to return the corresponding HTTPS status code if the error documents are hit. Valid values: Enabled (default), Disabled
String
No
Charity404
WebsiteConfiguration.ErrorDocument
Configures whether to display the 404 public welfare page when the error code is 404. Valid values: Enabled or Disabled. Default: Disabled.
String
No
Content of RoutingRules:
Node Name (Keyword)
Parent Node
Description
Type
Required
RoutingRule
WebsiteConfiguration.RoutingRules
A single routing rule
Container
Yes
Content of RoutingRules.RoutingRule:
Node Name (Keyword)
Parent Node
Description
Type
Required
Condition
WebsiteConfiguration.RoutingRules.RoutingRule
Condition for the routing rule
Container
Yes
Redirect
WebsiteConfiguration.RoutingRules.RoutingRule
Configuration of the redirection target
Container
Yes
Content of RoutingRules.RoutingRule.Condition:
Node Name (Keyword)
Parent Node
Description
Type
Required
HttpErrorCodeReturnedEquals
WebsiteConfiguration.RoutingRules.RoutingRule.Condition
Specifies the error code as the match condition for the routing rule. Valid values: only 4xx return codes, such as 403 or 404.
Integer
Either this parameter or KeyPrefixEquals must be specified.
KeyPrefixEquals
WebsiteConfiguration.RoutingRules.RoutingRule.Condition
Specifies the object key prefix as the match condition for the routing rule
String
Either this parameter or HttpErrorCodeReturnedEquals must be specified.
Content of RoutingRules.RoutingRule.Redirect:
Node Name (Keyword)
Parent Node
Description
Type
Required
Protocol
WebsiteConfiguration.RoutingRules.RoutingRule.Redirect
Specifies the target protocol for the routing rule. Only HTTPS is supported.
String
No
ReplaceKeyWith
WebsiteConfiguration.RoutingRules.RoutingRule.Redirect
Specifies the target object key to replace the original object key in the request.
String
Either this parameter or ReplaceKeyPrefixWith must be specified.
ReplaceKeyPrefixWith
WebsiteConfiguration.RoutingRules.RoutingRule.Redirect
Specifies the object key prefix to replace the original prefix in the request. You can set this parameter only if the condition is KeyPrefixEquals.
String
Either this parameter or ReplaceKeyWith must be specified.
URLRedirect
WebsiteConfiguration.RoutingRules.RoutingRule.Redirect
Whether the URL in the redirect rule changes according to the replacement content. Valid values: Enabled, Disabled. The default value is Enabled.
String
No

Response

Response headers

This API only returns Common Response Headers.

Response body

The response body of this API is empty.

Error codes

This API returns common error responses and error codes. For more information, please see Error Codes.

Samples

Request

PUT /?website HTTP/1.1
Host: examplebucket-1250000000.cos.ap-beijing.myqcloud.com
Date: Wed, 20 May 2020 09:33:38 GMT
Content-Type: application/xml
Content-Length: 1209
Content-MD5: VHzj4Uwb++HLyCJp7jUzWg==
Authorization: q-sign-algorithm=sha1&q-ak=AKID8A0fBVtYFrNm02oY1g1JQQF0c3JO****&q-sign-time=1589967218;1589974418&q-key-time=1589967218;1589974418&q-header-list=content-length;content-md5;content-type;date;host&q-url-param-list=website&q-signature=4666493555640e834a879c78afaa4fd9b16a****
Connection: close

<WebsiteConfiguration>
    <IndexDocument>
        <Suffix>index.html</Suffix>
    </IndexDocument>
    <RedirectAllRequestsTo>
        <Protocol>https</Protocol>
    </RedirectAllRequestsTo>
    <ErrorDocument>
        <Key>pages/error.html</Key>
    </ErrorDocument>
    <RoutingRules>
        <RoutingRule>
            <Condition>
                <HttpErrorCodeReturnedEquals>403</HttpErrorCodeReturnedEquals>
            </Condition>
            <Redirect>
                <Protocol>https</Protocol>
                <ReplaceKeyWith>pages/403.html</ReplaceKeyWith>
            </Redirect>
        </RoutingRule>
        <RoutingRule>
            <Condition>
                <HttpErrorCodeReturnedEquals>404</HttpErrorCodeReturnedEquals>
            </Condition>
            <Redirect>
                <ReplaceKeyWith>pages/404.html</ReplaceKeyWith>
            </Redirect>
        </RoutingRule>
        <RoutingRule>
            <Condition>
                <KeyPrefixEquals>assets/</KeyPrefixEquals>
            </Condition>
            <Redirect>
                <ReplaceKeyWith>index.html</ReplaceKeyWith>
            </Redirect>
        </RoutingRule>
        <RoutingRule>
            <Condition>
                <KeyPrefixEquals>article/</KeyPrefixEquals>
            </Condition>
            <Redirect>
                <Protocol>https</Protocol>
                <ReplaceKeyPrefixWith>archived/</ReplaceKeyPrefixWith>
            </Redirect>
        </RoutingRule>
    </RoutingRules>
</WebsiteConfiguration>

Response

HTTP/1.1 200 OK
Content-Length: 0
Connection: close
Date: Wed, 20 May 2020 09:33:38 GMT
Server: tencent-cos
x-cos-request-id: NWVjNGY5NzJfOThjMjJhMDlfMjg5Ml8yYzNi****

FAQs

Error Documents, 404 Default Pages, and Redirect Rules Take Effect in the Following Order of Precedence

If the user has configured the error document, enabled the 404 public welfare page, and set redirect rules simultaneously, the priority order when all three are triggered is: redirect rules > 404 public welfare page > error document.
次の記事へ: 製品アップデート情報

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック