tencent cloud

对象存储

动态与公告
产品动态
产品公告
产品简介
产品概述
功能概览
应用场景
产品优势
基本概念
地域和访问域名
规格与限制
产品计费
计费概述
计费方式
计费项
免费额度
计费示例
查看和下载账单
欠费说明
常见问题
快速入门
控制台快速入门
COSBrowser 快速入门
用户指南
创建请求
存储桶
对象
数据管理
批量处理
全球加速
监控与告警
运维中心
数据处理
内容审核
智能工具箱
数据工作流
应用集成
工具指南
工具概览
环境安装与配置
COSBrowser 工具
COSCLI 工具
COSCMD 工具
COS Migration 工具
FTP Server 工具
Hadoop 工具
COSDistCp 工具
HDFS TO COS 工具
GooseFS-Lite 工具
在线辅助工具
自助诊断工具
实践教程
概览
访问控制与权限管理
性能优化
使用 AWS S3 SDK 访问 COS
数据容灾备份
域名管理实践
图片处理实践
COS 音视频播放器实践
工作流实践
数据直传
内容审核实践
数据安全
数据校验
大数据实践
COS 成本优化解决方案
在第三方应用中使用 COS
迁移指南
本地数据迁移至 COS
第三方云存储数据迁移至 COS
以 URL 作为源地址的数据迁移至 COS
COS 之间数据迁移
Hadoop 文件系统与 COS 之间的数据迁移
数据湖存储
云原生数据湖
元数据加速
数据加速器 GooseFS
数据处理
数据处理概述
图片处理
媒体处理
内容审核
文件处理
文档处理
故障处理
获取 RequestId 操作指引
通过外网上传文件至 COS 缓慢
访问 COS 时返回403错误码
资源访问异常
POST Object 常见异常
API 文档
简介
公共请求头部
公共响应头部
错误码
请求签名
操作列表
Service 接口
Bucket 接口
Object 接口
批量处理接口
数据处理接口
任务与工作流
内容审核接口
云查毒接口
SDK 文档
SDK 概览
准备工作
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
小程序 SDK
错误码
鸿蒙(Harmony) SDK
终端 SDK 质量优化
安全与合规
数据容灾
数据安全
访问管理
常见问题
热门问题
一般性问题
计费计量问题
域名合规问题
存储桶配置问题
域名和 CDN 问题
文件操作问题
日志监控问题
权限管理问题
数据处理问题
数据安全问题
预签名 URL 问题
SDK 类问题
工具类问题
API 类问题
服务协议
Service Level Agreement
隐私政策
数据处理和安全协议
联系我们
词汇表

PUT Bucket website

PDF
聚焦模式
字号
最后更新时间: 2026-02-27 15:29:00

功能描述

PUT Bucket website 请求用于为存储桶配置静态网站,您可以通过传入 XML 格式的配置文件进行配置,文件大小限制为64KB。
注意:
如果存储桶已存在静态网站配置,调用此接口会覆盖掉已有的静态网站配置信息。


授权说明

授权策略中 action 设置为 cos:PutBucketWebsite 。查看所有 action

请求

请求示例

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]
说明:
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com,其中 <BucketName-APPID> 为带 APPID 后缀的存储桶名字,例如 examplebucket-1250000000,可参见 存储桶概览 > 基本信息存储桶概述 > 存储桶命名规范 文档;<Region> 为 COS 的可用地域,可参见 地域和访问域名 文档。
Authorization: Auth String(详情请参见 请求签名 文档)。

请求参数

此接口无请求参数。

请求头

此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。

请求体

提交 application/xml 请求数据,包含完整的存储桶静态网站配置信息。
<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>
具体的节点描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
WebsiteConfiguration
包含 PUT Bucket website 操作的所有请求信息
Container
Container 节点 WebsiteConfiguration 的内容:
节点名称(关键字)
父节点
描述
类型
是否必选
IndexDocument
WebsiteConfiguration
索引文档配置
Container
RedirectAllRequestsTo
WebsiteConfiguration
重定向所有请求配置
Container
AutoAddressing
WebsiteConfiguration
用于配置是否忽略扩展名
Container
ErrorDocument
WebsiteConfiguration
错误文档配置
Container
RoutingRules
WebsiteConfiguration
重定向规则配置,最多设置100条 RoutingRule
Container
Container 节点 IndexDocument 的内容:
节点名称(关键字)
父节点
描述
类型
是否必选
Suffix
WebsiteConfiguration.IndexDocument
指定索引文档的对象键后缀。例如指定为 index.html,那么当访问到存储桶的根目录时,会自动返回 index.html 的内容,或者当访问到 article/ 目录时,会自动返回 article/index.html 的内容
String
Container 节点 RedirectAllRequestsTo 的内容:
节点名称(关键字)
父节点
描述
类型
是否必选
Protocol
WebsiteConfiguration.RedirectAllRequestsTo
指定重定向所有请求的目标协议,只能设置为 https
String
Container 节点 AutoAddressing 的内容:
节点名称(关键字)
父节点
描述
类型
是否必选
Status
WebsiteConfiguration.AutoAddressing
用于配置是否忽略 HTML 拓展名,可选值为 Enabled 或 Disabled,默认为 Disabled
String
Container 节点 ErrorDocument 的内容:
节点名称(关键字)
父节点
描述
类型
是否必选
Key
WebsiteConfiguration.ErrorDocument
指定通用错误文档的对象键,当发生错误且未命中重定向规则中的错误码重定向时,将返回该对象键的内容
String
OriginalHttpStatus
WebsiteConfiguration.ErrorDocument
用于配置命中错误文档的 HTTP 状态码,可选值为 Enabled 或 Disabled,默认为 Enabled
String
Charity404
WebsiteConfiguration.ErrorDocument
用于配置错误码为404时,是否展示404公益页面,可选值为Enabled 或 Disabled,默认为 Disabled。
String
Container 节点 RoutingRules 的内容:
节点名称(关键字)
父节点
描述
类型
是否必选
RoutingRule
WebsiteConfiguration.RoutingRules
单条重定向规则配置
Container
Container 节点 RoutingRules.RoutingRule 的内容:
节点名称(关键字)
父节点
描述
类型
是否必选
Condition
WebsiteConfiguration.RoutingRules.RoutingRule
重定向规则的条件配置
Container
Redirect
WebsiteConfiguration.RoutingRules.RoutingRule
重定向规则的具体重定向目标配置
Container
Container 节点 RoutingRules.RoutingRule.Condition 的内容:
节点名称(关键字)
父节点
描述
类型
是否必选
HttpErrorCodeReturnedEquals
WebsiteConfiguration.RoutingRules.RoutingRule.Condition
指定重定向规则的错误码匹配条件,只支持配置4XX返回码,例如403或404
Integer
HttpErrorCodeReturnedEquals 与 KeyPrefixEquals 必选其一
KeyPrefixEquals
WebsiteConfiguration.RoutingRules.RoutingRule.Condition
指定重定向规则的对象键前缀匹配条件
String
HttpErrorCodeReturnedEquals 与 KeyPrefixEquals 必选其一
Container 节点 RoutingRules.RoutingRule.Redirect 的内容:
节点名称(关键字)
父节点
描述
类型
是否必选
Protocol
WebsiteConfiguration.RoutingRules.RoutingRule.Redirect
指定重定向规则的目标协议,只能设置为 https
String
ReplaceKeyWith
WebsiteConfiguration.RoutingRules.RoutingRule.Redirect
指定重定向规则的具体重定向目标的对象键,替换方式为替换整个原始请求的对象键
String
ReplaceKeyWith 与 ReplaceKeyPrefixWith 必选其一
ReplaceKeyPrefixWith
WebsiteConfiguration.RoutingRules.RoutingRule.Redirect
指定重定向规则的具体重定向目标的对象键,替换方式为替换原始请求中所匹配到的前缀部分,仅可在 Condition 为 KeyPrefixEquals 时设置
String
ReplaceKeyWith 与 ReplaceKeyPrefixWith 必选其一
URLRedirect
WebsiteConfiguration.RoutingRules.RoutingRule.Redirect
重定向规则中 URL 是否跟随替换内容做更改。枚举值:Enabled、Disabled。默认值为 Enabled
String

响应

响应头

此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。

响应体

此接口响应体为空。

错误码

此接口遵循统一的错误响应和错误码,详情请参见 错误码 文档。

实际案例

请求

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=************************************&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=****************************************
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>

响应

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****

常见问题

错误文档、404公益页面、重定向规则按什么优先级生效?

若用户同时设置了错误文档、开启404公益页面、重定向规则,三类设置同时命中时,生效优先级为:重定向规则 > 404公益页面 > 错误文档。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈