静态网站

最后更新时间:2020-03-11 18:12:55

    简介

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

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

    设置静态网站

    功能说明

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

    方法原型

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

    请求示例

    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)

    请求示例

    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)

    请求示例

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

    参数说明

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

    返回结果说明

    该方法返回值为 None。

    Was this page helpful?

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

    • 完全没帮助
    • 文档较差
    • 文档一般
    • 文档不错
    • 文档很好
    反馈
    帮助