# 获取桶的Website配置(Python SDK) #### 功能介绍 OBS允许在桶内保存静态的网页资源，如.html网页文件、flash文件、音视频文件等，当客户端通过桶的Website接入点访问这些对象资源时，浏览器可以直接解析出这些支持的网页资源，呈现给最终用户。典型的应用场景有： - 重定向所有的请求到另外一个站点。 - 设定特定的重定向规则来重定向特定的请求。 调用获取桶的网站配置接口，您可以获取指定桶的网站配置信息。 #### 接口约束 - 您必须是桶拥有者或拥有获取桶的网站配置的权限，才能获取桶的网站配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketWebsite权限，如果使用桶策略则需授予GetBucketWebsite权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 ObsClient.getBucketWebsite(bucketName, extensionHeaders) #### 请求参数说明 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | bucketName | str | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值：** 无 | | extensionHeaders | dict | 可选 | **参数解释：** 接口的拓展头域。 **取值范围：** 参考[自定义头域](https://support.huaweicloud.com/sdk-python-devg-obs/obs_22_1305.html)。 **默认取值：** 无 | #### 返回结果说明 | **类型** | **说明** | |:---|:---| | [GetResult] | **参数解释：** SDK公共结果对象。 | 表1GetResult | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | status | int | **参数解释：** HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | | reason | str | **参数解释：** HTTP文本描述。 **默认取值：** 无 | | errorCode | str | **参数解释：** OBS服务端错误码，当status参数小于300时为空。 **默认取值：** 无 | | errorMessage | str | **参数解释：** OBS服务端错误描述，当status参数小于300时为空。 **默认取值：** 无 | | requestId | str | **参数解释：** OBS服务端返回的请求ID。 **默认取值：** 无 | | indicator | str | **参数解释：** OBS服务端返回的错误定位码。 **默认取值：** 无 | | hostId | str | **参数解释：** 请求的服务端ID，当status参数小于300时为空。 **默认取值：** 无 | | resource | str | **参数解释：** 发生错误时相关的桶或对象，当status参数小于300时为空。 **默认取值：** 无 | | header | list | **参数解释：** 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 **默认取值：** 无 | | body | object | **参数解释：** 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见"桶相关接口"章节和"对象相关接口"章节的详细描述。 **默认取值：** 无 | | **GetResult.body类型** | **说明** | |:---|:---| | [WebsiteConfiguration] | **参数解释：** 桶的Website配置。 | 表2WebsiteConfiguration | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | redirectAllRequestTo | [RedirectAllRequestTo] | 作为请求参数时可选 | **参数解释：** 所有请求重定向规则，详见[RedirectAllRequestTo]。 | | indexDocument | [IndexDocument] | 作为请求参数时可选 | **参数解释：** 默认页面配置，详见[IndexDocument]。 | | errorDocument | [ErrorDocument] | 作为请求参数时可选 | **参数解释：** 错误页面配置，详见[ErrorDocument]。 | | routingRules | list of [RoutingRule] | 作为请求参数时可选 | **参数解释：** 请求重定向规则列表，详见[RoutingRule]。 | ![](https://support.huaweicloud.com/sdk-python-devg-obs/public_sys-resources/note_3.0-zh-cn.png) - errorDocument、indexDocument和routingRules必须配套使用，且与redirectAllRequestsTo互斥。当设置了这三个字段时，不能设置redirectAllRequestsTo；反之，当设置了redirectAllRequestsTo时，不能设置errorDocument、indexDocument和routingRules。 - 当errorDocument、indexDocument和routingRules三个字段一起使用时，routingRules可为空。 - errorDocument、indexDocument、routingRules与redirectAllRequestsTo不能全为空。 表3RedirectAllRequestTo | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | hostName | str | 作为请求参数时必选 | **参数解释：** 重定向时使用的域名。如 www.example.com。 **约束限制：** 域名需符合域名规范。 **默认取值：** 无 | | protocol | str | 作为请求参数时可选 | **参数解释：** 重定向请求时使用的协议。 **取值范围：** - http - https **默认取值：** 无 | 表4IndexDocument | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | suffix | str | 作为请求参数时必选 | **参数解释：** 该字段被追加在对文件夹的请求的末尾（例如：suffix参数设置为"index.html"，请求的是"samplebucket/images/"，返回的数据将是"samplebucket"桶内名为"images/index.html"的对象的内容）。 **取值范围：** 该字段不能为空或者包含"/"字符。 **默认取值：** 无 | 表5ErrorDocument | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | key | str | 作为请求参数时可选 | **参数解释：** 当4XX错误出现时使用的对象的名称。这个元素指定当错误出现时返回的页面。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | 表6RoutingRule | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | condition | [Condition] | 作为请求参数时可选 | **参数解释：** 重定向规则生效需要满足的条件。 **取值范围：** 匹配条件选择范围详见[Condition]。 **默认取值：** 无 | | redirect | [Redirect] | 作为请求参数时必选 | **参数解释：** 重定向请求时的具体信息，详见[Redirect]。 **默认取值：** 无 | 表7Condition | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | keyPrefixEquals | str | 作为请求参数时可选 | **参数解释：** 重定向生效时的对象名前缀。当向对象发送请求时，如果对象名前缀等于这个值，那么重定向生效。 例如：重定向ExamplePage.html对象的请求，KeyPrefixEquals设为ExamplePage.html。 **约束限制：** 与httpErrorCodeReturnedEquals参数不可同时使用，两者二选一。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | httpErrorCodeReturnedEquals | int | 作为请求参数时可选 | **参数解释：** 重定向生效时的HTTP错误码。当发生错误时，如果错误码等于这个值，那么重定向生效。 例如：当返回的HTTP错误码为404时重定向到NotFound.html，可以将Condition中的HttpErrorCodeReturnedEquals设置为404，Redirect中的ReplaceKeyWith设置为NotFound.html。 **约束限制：** 与keyPrefixEquals参数不可同时使用，两者二选一。 **取值范围：** 取值范围可参见[错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html)。 **默认取值：** 无 | 表8Redirect | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | protocol | str | 作为请求参数时可选 | **参数解释：** 重定向请求时使用的协议。 **取值范围：** - http - https **默认取值：** 无 | | hostName | str | 作为请求参数时可选 | **参数解释：** 重定向请求时使用的域名。 **默认取值：** 无 | | replaceKeyPrefixWith | str | 作为请求参数时可选 | **参数解释：** 重定向请求时使用的对象名前缀。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | replaceKeyWith | str | 作为请求参数时可选 | **参数解释：** 重定向请求时使用的对象名。 **约束限制：** 不可与replaceKeyPrefixWith同时使用。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | httpRedirectCode | int | 作为请求参数时可选 | **参数解释：** 重定向请求时响应中的HTTP状态码，详见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | #### 代码样例 本示例用于获取名为examplebucket的桶website配置。 ``` import os import traceback from obs import ObsClient # 推荐通过环境变量获取AK/SK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险 # 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html ak = os.getenv("AccessKeyID") sk = os.getenv("SecretAccessKey") # 如需使用临时AK/SK和SecurityToken访问OBS，则同样推荐通过环境变量获取 # security_token = os.getenv("SecurityToken") # server填写Bucket对应的Endpoint，这里以华北-北京四为例，其他地区请按实际情况填写 server = "https://obs.cn-north-4.myhuaweicloud.com" # 创建obsClient实例 # 如果使用临时AK/SK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值 obs_client = ObsClient(access_key_id=ak, secret_access_key=sk, server=server) try: bucket_name = "examplebucket" #获取桶website配置 resp = obs_client.getBucketWebsite(bucket_name) # 返回码为2xx时，接口调用成功，否则接口调用失败 if resp.status < 300: print('Get Bucket Website Succeeded') print('requestId:', resp.requestId) if resp.body.redirect_all_request_to: print('redirectAllRequestTo.hostName:', resp.body.redirect_all_request_to.hostName, ',redirectAllRequestTo.protocol:', resp.body.redirect_all_request_to.protocol) if resp.body.index_document: print('indexDocument.suffix:', resp.body.index_document.suffix) if resp.body.error_document: print('errorDocument.key:', resp.body.error_document.key) if resp.body.routing_rules: index = 1 for rout in resp.body.routing_rules: print('routingRule[', index, ']:') index += 1 print('condition.keyPrefixEquals:', rout.condition.keyPrefixEquals, ',condition.httpErrorCodeReturnedEquals:', rout.condition.httpErrorCodeReturnedEquals) print('redirect.protocol:', rout.redirect.protocol, ',redirect.hostName:', rout.redirect.hostName, ',redirect.replaceKeyPrefixWith:', rout.redirect.replaceKeyPrefixWith, ',redirect.replaceKeyWith:', rout.redirect.replaceKeyWith, ',redirect.httpRedirectCode:', rout.redirect.httpRedirectCode) else: print('Get Bucket Website Failed') print('requestId:', resp.requestId) print('errorCode:', resp.errorCode) print('errorMessage:', resp.errorMessage) except Exception: print('Get Bucket Website Failed') print(traceback.format_exc()) ``` #### 相关链接 - 关于获取桶的网站配置的API说明，请参见[获取桶的网站配置](https://support.huaweicloud.com/api-obs/obs_04_0072.html)。 - 更多关于获取桶的网站配置的示例代码，请参见[Github示例](https://github.com/huaweicloud/huaweicloud-sdk-python-obs/blob/master/examples/bucket_operations_sample.py)。 - 获取桶的网站配置过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 - 静态网站托管相关常见问题请参见[静态网站托管相关常见问题](https://support.huaweicloud.com/obs_faq/obs_faq_0500.html)。