控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

静态网站

最近更新时间:2021-12-10 17:08:20

简介

本文档提供关于静态网站的 API 概览以及 SDK 示例代码。

API 操作名 操作描述
PUT Bucket website 设置静态网站 设置存储桶的静态网站配置
GET Bucket website 查询静态网站配置 查询存储桶的静态网站配置
DELETE Bucket website 删除静态网站配置 删除存储桶的静态网站配置

设置静态网站

功能说明

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

方法原型

put_bucket_website(Bucket, WebsiteConfiguration={}, **kwargs)

请求示例

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import logging

# 正常情况日志级别使用INFO,需要定位时可以修改为DEBUG,此时SDK会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)

# 1. 设置用户属性, 包括 secret_id, secret_key, region等。Appid 已在CosConfig中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = 'SecretId'     # 替换为用户的 SecretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # 替换为用户的 SecretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # 替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
                           # COS支持的所有region列表参见https://cloud.tencent.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见https://cloud.tencent.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS,默认为 https,可不填

config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)

response = client.put_bucket_website(
    Bucket='bucket',
    WebsiteConfiguration={
        'IndexDocument': {
            'Suffix': 'string'
        },
        'ErrorDocument': {
            'Key': 'string'
        },
        'RedirectAllRequestsTo': {
            'Protocol': 'http'|'https'
        },
        'RoutingRules': [
            {
                'Condition': {
                    'HttpErrorCodeReturnedEquals': 'string',
                    'KeyPrefixEquals': 'string'
                },
                'Redirect': {
                    'HttpRedirectCode': 'string',
                    'Protocol': 'http'|'https',
                    'ReplaceKeyPrefixWith': 'string',
                    'ReplaceKeyWith': 'string'
                }
            }
        ]
    }
)

参数说明

参数名称 参数描述 类型 是否必填
Bucket 设置静态网站的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范 String
IndexDocument 设置静态网站首页的配置 Dict
Suffix 静态网站首页地址的后缀配置 String
ErrorDocument 设置静态网站错误页面配置 Dict
Key 错误页面地址 String
RedirectAllRequestsTo 设置全站重定向配置 Dict
Protocol 全站重定向协议,可选值为 http、https String
RoutingRules 设置静态网站路由规则 List
Condition 路由的条件,包括错误码重定向和前缀重定向 Dict
HttpErrorCodeReturnedEquals 错误码重定向的条件 String
KeyPrefixEquals 前缀重定向的条件 String
Redirect 重定向的具体规则 Dict
HttpRedirectCode 重定向时的错误码 String
Protocol 重定向的协议,可选值为 http、https String
ReplaceKeyPrefixWith 重定向时替换前缀为指定的 key String
ReplaceKeyWith 重定向时替换整个路径为指定的 key String

返回结果说明

该方法返回值为 None。

查询静态网站配置

功能说明

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

方法原型

get_bucket_website(Bucket, **kwargs)

请求示例

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import logging

# 正常情况日志级别使用INFO,需要定位时可以修改为DEBUG,此时SDK会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)

# 1. 设置用户属性, 包括 secret_id, secret_key, region等。Appid 已在CosConfig中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = 'SecretId'     # 替换为用户的 SecretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # 替换为用户的 SecretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # 替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
                           # COS支持的所有region列表参见https://cloud.tencent.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见https://cloud.tencent.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS,默认为 https,可不填

config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)

response = client.get_bucket_website(
    Bucket='examplebucket-1250000000'
)

参数说明 |

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

返回结果说明

Bucket 静态网站配置,类型为 dict。

{
    'IndexDocument': {
        'Suffix': 'string'
    },
    'ErrorDocument': {
        'Key': 'string'
    },
    'RedirectAllRequestsTo': {
        'Protocol': 'http'|'https'
    },
    'RoutingRules': [
        {
            'Condition': {
                'HttpErrorCodeReturnedEquals': 'string',
                'KeyPrefixEquals': 'string'
            },
            'Redirect': {
                'HttpRedirectCode': 'string',
                'Protocol': 'http'|'https',
                'ReplaceKeyPrefixWith': 'string',
                'ReplaceKeyWith': 'string'
            }
        }
    ]
}

参数名称 参数描述 类型
IndexDocument 设置静态网站首页的配置 Dict
Suffix 静态网站首页地址的后缀配置 String
ErrorDocument 设置静态网站错误页面配置 Dict
Key 错误页面地址 String
RedirectAllRequestsTo 设置全站重定向配置 Dict
Protocol 全站重定向协议,可选值为 http、https String
RoutingRules 设置静态网站路由规则 List
Condition 路由的条件,包括错误码重定向和前缀重定向 Dict
HttpErrorCodeReturnedEquals 错误码重定向的条件 String
KeyPrefixEquals 前缀重定向的条件 String
Redirect 重定向的具体规则 Dict
HttpRedirectCode 重定向时的错误码 String
Protocol 重定向的协议,可选值为 http、https String
ReplaceKeyPrefixWith 重定向时替换前缀为指定的 key String
ReplaceKeyWith 重定向时替换整个路径为指定的 key String

删除静态网站配置

功能说明

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

方法原型

delete_bucket_website(Bucket, **kwargs)

请求示例

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import logging

# 正常情况日志级别使用INFO,需要定位时可以修改为DEBUG,此时SDK会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)

# 1. 设置用户属性, 包括 secret_id, secret_key, region等。Appid 已在CosConfig中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = 'SecretId'     # 替换为用户的 SecretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # 替换为用户的 SecretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # 替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
                           # COS支持的所有region列表参见https://cloud.tencent.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见https://cloud.tencent.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS,默认为 https,可不填

config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)

response = client.delete_bucket_website(
    Bucket='examplebucket-1250000000'
)

参数说明

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

返回结果说明

该方法返回值为 None。

目录