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-22 11:07:56
本文档提供关于静态网站的 API 概览以及 SDK 示例代码。
API
操作名
操作描述
设置静态网站
设置存储桶的静态网站配置
查询静态网站配置
查询存储桶的静态网站配置
删除静态网站配置
删除存储桶的静态网站配置

设置静态网站

功能说明

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

方法原型

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

请求示例

<?php

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

$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.tencentcloud.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.tencentcloud.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.tencentcloud.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
array(
'region' => $region,
'schema' => 'https', //协议头部,默认为http
'credentials'=> array(
'secretId' => $secretId ,
'secretKey' => $secretKey)));

try {
$result = $cosClient->putBucketWebsite(array(
'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 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
),
));
// 请求成功
print_r($result);
} catch (\\Exception $e) {
// 请求失败
echo "$e\\n";
}

参数说明

参数名称
父节点
描述
类型
是否必选
Bucket
设置静态网站的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范
String
IndexDocument
索引文档
Array
Suffix
IndexDocument
指定索引文档
String
ErrorDocument
错误文档
Array
Key
ErrorDocument
指定通用错误返回
String
RedirectAllRequestsTo
重定向所有请求
Array
Protocol
RedirectAllRequestsTo
指定全站重定向的协议,只能设置为 https
String
RoutingRules
设置重定向规则,最多设置100条 RoutingRule
Array
RoutingRule
RoutingRules
设置单条重定向规则,包括前缀匹配重定向和错误码重定向
Array
Condition
RoutingRule
指定重定向发生的条件,前缀匹配重定向和错误码重定向只能指定一个
Array
HttpErrorCodeReturnedEquals
Condition
指定重定向错误码,只支持配置4XX返回码,优先级高于 ErrorDocument
Interger
KeyPrefixEquals
Condition
指定前缀重定向的路径,替换指定的 folder/
String
Redirect
RoutingRule
指定满足重定向 conditon 时重定向的具体替换规则
Array
ReplaceKeyWith
Redirect
替换整个 Key 为指定的内容
String
ReplaceKeyPrefixWith
Redirect
替换匹配到的前缀为指定的内容,Conditon 为 KeyPrefixEquals 才可设置
String

查询静态网站配置

功能说明

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

方法原型

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

请求示例

<?php

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

$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.tencentcloud.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.tencentcloud.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.tencentcloud.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
array(
'region' => $region,
'schema' => 'https', //协议头部,默认为http
'credentials'=> array(
'secretId' => $secretId ,
'secretKey' => $secretKey)));

try {
$result = $cosClient->getBucketWebsite(array(
'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.tencentcloud.com/cos5/bucket
));
// 请求成功
print_r($result);
} catch (\\Exception $e) {
// 请求失败
echo "$e\\n";
}

参数说明

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

返回结果示例

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

返回结果说明

参数名称
描述
类型
Bucket
存储桶名称格式为 BucketName-APPID ,详情请参见 命名规范
String
IndexDocument
索引文档
Array
Suffix
指定索引文档
String
ErrorDocument
错误文档
Array
Key
指定通用错误返回
String
RedirectAllRequestsTo
重定向所有请求
Array
Protocol
指定全站重定向的协议,只能设置为 https
String
RoutingRules
设置重定向规则,最多设置100条 RoutingRule
Array
RoutingRule
设置单条重定向规则,包括前缀匹配重定向和错误码重定向
Array
Condition
指定重定向发生的条件,前缀匹配重定向和错误码重定向只能指定一个
Array
HttpErrorCodeReturnedEquals
指定重定向错误码,只支持配置4XX返回码,优先级高于 ErrorDocument
Interger
KeyPrefixEquals
指定前缀重定向的路径,替换指定的 folder/
String
Redirect
指定满足重定向 conditon 时重定向的具体替换规则
Array
ReplaceKeyWith
替换整个 Key 为指定的内容
String
ReplaceKeyPrefixWith
替换匹配到的前缀为指定的内容,Conditon 为 KeyPrefixEquals 才可设置
String

删除静态网站配置

功能说明

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

方法原型

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

请求示例

<?php

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

$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.tencentcloud.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.tencentcloud.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.tencentcloud.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
array(
'region' => $region,
'schema' => 'https', //协议头部,默认为http
'credentials'=> array(
'secretId' => $secretId ,
'secretKey' => $secretKey)));

try {
$result = $cosClient->deleteBucketWebsite(array(
'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.tencentcloud.com/cos5/bucket
));
// 请求成功
print_r($result);
} catch (\\Exception $e) {
// 请求失败
echo "$e\\n";
}

参数说明

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

帮助和支持

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

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

文档反馈