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
隐私政策
数据处理和安全协议
联系我们
词汇表

静态网站

PDF
聚焦模式
字号
最后更新时间: 2024-01-19 16:15:11

简介

本文档提供关于静态网站的 API 概览以及 SDK 示例代码。
API
操作名
操作描述
设置静态网站
为已存在的存储桶设置静态网站配置信息
查询静态网站
查询指定存储桶的静态网站配置信息
删除静态网站
删除指定存储桶的静态网站配置信息

设置静态网站

功能说明

为已存在的存储桶配置静态网站。

请求示例

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

参数说明

参数名称
描述
类型
是否必填
Bucket
设置静态网站的存储桶,格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
String
Region
存储桶所在地域,枚举值请参见 地域和访问域名
String
WebsiteConfiguration
静态网站配置,包括索引文档、错误文档、协议转换和重定向规则
Object
- IndexDocument
索引文档
Object
- - Suffix
指定索引文档
String
- ErrorDocument
错误文档
Object
- - Key
指定通用错误返回
String
- RedirectAllRequestsTo
重定向所有请求
Object
- - Protocol
指定全站重定向的协议,只能设置为 https
String
- RoutingRules
设置重定向规则,最多设置100条
ObjectArray
- - Condition
指定重定向发生的条件,前缀匹配重定向和错误码重定向只能指定一个
Object
- - - HttpErrorCodeReturnedEquals
指定重定向错误码,只支持配置4XX返回码,优先级高于ErrorDocument
String
- - - KeyPrefixEquals
指定前缀重定向的路径,替换指定的 folder/
String
- - Redirect
指定满足重定向 conditon 时重定向的具体替换规则
Object
- - - ReplaceKeyWith
替换整个 Key 为指定的内容
String
- - - ReplaceKeyPrefixWith
替换匹配到的前缀为指定的内容,Conditon 为 KeyPrefixEquals 才可设置
String

回调函数说明

function(err, data) { ... }
参数名称
描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档
Object
- statusCode
请求返回的 HTTP 状态码,如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,如200、403、404等
Number
- headers
请求返回的头部信息
Object

查询静态网站配置

功能说明

查询与指定存储桶关联的静态网站配置信息。

请求示例

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

返回示例

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

参数说明

参数名称
描述
类型
是否必填
Bucket
查询静态网站配置的存储桶,格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
String
Region
存储桶所在地域,枚举值请参见 地域和访问域名
String

回调函数说明

function(err, data) { ... }
参数名称
描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档
Object
- statusCode
请求返回的 HTTP 状态码,如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,如200、403、404等
Number
- headers
请求返回的头部信息
Object
- WebsiteConfiguration
静态网站配置,包括索引文档、错误文档、协议转换和重定向规则
Object
- - IndexDocument
索引文档
Object
- - - Suffix
指定索引文档
String
- - ErrorDocument
错误文档
Object
- - - Key
指定通用错误返回
String
- - RedirectAllRequestsTo
重定向所有请求
Object
- - - Protocol
指定全站重定向的协议,只能设置为 https
String
- - RoutingRules
设置重定向规则,最多设置100条
ObjectArray
- - - Condition
指定重定向发生的条件,前缀匹配重定向和错误码重定向只能指定一个
Object
- - - - HttpErrorCodeReturnedEquals
指定重定向错误码,只支持配置4XX 返回码,优先级高于ErrorDocument
String
- - - - KeyPrefixEquals
指定前缀重定向的路径,替换指定的 folder/
String
- - - Redirect
指定满足重定向 conditon 时重定向的具体替换规则
Object
- - - - ReplaceKeyWith
替换整个 Key 为指定的内容
String
- - - - ReplaceKeyPrefixWith
替换匹配到的前缀为指定的内容,Conditon 为 KeyPrefixEquals 才可设置
String

删除静态网站配置

功能说明

删除指定存储桶中的静态网站配置。

请求示例

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

参数说明

参数名称
描述
类型
是否必填
Bucket
被删除静态网站配置的存储桶,格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
String
Region
存储桶所在地域,枚举值请参见 地域和访问域名
String

回调函数说明

function(err, data) { ... }
参数名称
描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档
Object
- statusCode
请求返回的 HTTP 状态码,如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,如200、403、404等
Number
- headers
请求返回的头部信息
Object

帮助和支持

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

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

文档反馈