tencent cloud

文档反馈

静态网站

最后更新时间:2024-01-19 15:33:39

简介

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

设置静态网站

功能说明

PUT Bucket website 用于为存储桶配置静态网站。

方法原型

public void setBucketWebsiteConfiguration(String bucketName, BucketWebsiteConfiguration configuration)
throws CosClientException, CosServiceException;
public void setBucketWebsiteConfiguration(SetBucketWebsiteConfigurationRequest setBucketWebsiteConfigurationRequest)
throws CosClientException, CosServiceException;

请求示例

String bucketName = "examplebucket-1250000000";
// 设置bucket website
BucketWebsiteConfiguration bucketWebsiteConfiguration = new BucketWebsiteConfiguration();
// 索引文件
bucketWebsiteConfiguration.setIndexDocumentSuffix("index.html");
// 路由规则
List<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);

参数说明

参数名称
描述
类型
setBucketWebsiteConfigurationRequest
存储桶静态网站设置请求
SetBucketWebsiteConfigurationRequest
Request 成员说明 :
Request 成员
设置方法
描述
类型
bucketName
构造函数或 set 方法
设置静态网站的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范
String
configuration
构造函数或 set 方法
存储桶的静态网站配置
BucketWebsiteConfiguration
BucketWebsiteConfiguration 成员说明:
参数名称
描述
类型
indexDocumentSuffix
索引文档
String
errorDocument
错误文档
String
redirectAllRequestsTo
重定向所有请求配置
RedirectRule
routingRules
设置重定向规则,最多设置100条 RoutingRule
List
RoutingRule 成员说明:
参数名称
描述
类型
condition
指定重定向发生的条件,前缀匹配重定向和错误码重定向只能指定一个
RoutingRuleCondition
redirect
重定向规则
RedirectRule
RoutingRuleCondition 成员说明:
参数名称
描述
类型
keyPrefixEquals
指定前缀重定向的路径
RoutingRuleCondition
httpErrorCodeReturnedEquals
指定重定向错误码
RedirectRule
RedirectRule 成员说明:
参数名称
描述
类型
protocol
指定全站重定向的协议
String
replaceKeyPrefixWith
替换匹配到的前缀为指定的内容,Conditon 为 KeyPrefixEquals 才可设置
String
replaceKeyWith
替换整个 Key 为指定的内容
String
httpRedirectCode
指定全站重定向的协议
String

返回结果说明

成功:无返回值。
失败:发生错误(如身份认证失败),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理

查询静态网站配置

功能说明

GET Bucket website 用于查询与存储桶关联的静态网站配置信息。

方法原型

public BucketWebsiteConfiguration getBucketWebsiteConfiguration(String bucketName)
throws CosClientException, CosServiceException;

请求示例

String bucketName = "examplebucket-1250000000";
BucketWebsiteConfiguration bucketWebsiteConfiguration = cosclient.getBucketWebsiteConfiguration(bucketName);

参数说明

参数名称
描述
类型
bucketName
查询静态网站配置的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范
String

返回结果说明

成功:返回 BucketWebsiteConfiguration,包含存储桶的静态网站设置信息。
失败:发生错误(如身份认证失败),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理

删除静态网站配置

功能说明

DELETE Bucket website 用于删除存储桶中的静态网站配置。

方法原型

public void deleteBucketWebsiteConfiguration(String bucketName) throws CosClientException, CosServiceException;

请求示例

String bucketName = "examplebucket-1250000000";
cosclient.deleteBucketWebsiteConfiguration(bucketName);

参数说明

参数名称
描述
类型
bucketName
被删除静态网站配置的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范
String

返回结果说明

成功:无返回值。
失败:发生错误(如身份认证失败),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理
联系我们

联系我们,为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持