华为云首页 用户手册

对象存储服务 OBS-设置桶的Website配置(Python SDK):请求参数说明

对象存储服务 OBS-设置桶的Website配置(Python SDK):请求参数说明

时间：2024-11-13 17:03:34
对象存储服务 OBS

请求参数说明

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。
  • 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

website

WebsiteConfiguration

必选

参数解释：

设置桶的网站配置请求参数，详见WebsiteConfiguration。

默认取值：

无

extensionHeaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

参考自定义头域。

默认取值：

无
表1 WebsiteConfiguration

参数名称

参数类型

是否必选

描述

redirectAllRequestTo

RedirectAllRequestTo

作为请求参数时可选

参数解释：

所有请求重定向规则，详见RedirectAllRequestTo。

默认取值：

无

indexDocument

IndexDocument

作为请求参数时可选

参数解释：

默认页面配置，详见IndexDocument。

默认取值：

无

errorDocument

ErrorDocument

作为请求参数时可选

参数解释：

错误页面配置，详见ErrorDocument。

默认取值：

无

routingRules

list of RoutingRule

作为请求参数时可选

参数解释：

请求重定向规则列表，详见RoutingRule。

默认取值：

无
  • errorDocument、indexDocument和routingRules必须配套使用，且与redirectAllRequestsTo互斥。当设置了这三个字段时，不能设置redirectAllRequestsTo；反之，当设置了redirectAllRequestsTo时，不能设置errorDocument、indexDocument和routingRules。
  • 当errorDocument、indexDocument和routingRules三个字段一起使用时，routingRules可为空。
  • errorDocument、indexDocument、routingRules与redirectAllRequestsTo不能全为空。
表2 RedirectAllRequestTo

参数名称

参数类型

是否必选

描述

hostName

str

作为请求参数时必选

参数解释：

重定向时使用的 域名 。如 www.example.com。

约束限制：

域名需符合域名规范。

默认取值：

无

protocol

str

作为请求参数时可选

参数解释：

重定向请求时使用的协议。

取值范围：

  • http
  • https

默认取值：

无
表3 IndexDocument

参数名称

参数类型

是否必选

描述

suffix

str

作为请求参数时必选

参数解释：

该字段被追加在对文件夹的请求的末尾（例如：suffix参数设置为“index.html”，请求的是“samplebucket/images/”，返回的数据将是“samplebucket”桶内名为“images/index.html”的对象的内容）。

取值范围：

该字段不能为空或者包含“/”字符。

默认取值：

无
表4 ErrorDocument

参数名称

参数类型

是否必选

描述

key

str

作为请求参数时可选

参数解释：

当4XX错误出现时使用的对象的名称。这个元素指定当错误出现时返回的页面。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无
表5 RoutingRule

参数名称

参数类型

是否必选

描述

condition

Condition

作为请求参数时可选

参数解释：

重定向规则生效需要满足的条件。

取值范围：

匹配条件选择范围详见Condition。

默认取值：

无

redirect

Redirect

作为请求参数时必选

参数解释：

重定向请求时的具体信息，详见Redirect。

默认取值：

无
表6 Condition

参数名称

参数类型

是否必选

描述

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参数不可同时使用，两者二选一。

取值范围：

取值范围可参见错误码。

默认取值：

无
表7 Redirect

参数名称

参数类型

是否必选

描述

protocol

str

作为请求参数时可选

参数解释：

重定向请求时使用的协议。

取值范围：

  • http
  • https

默认取值：

无

hostName

str

作为请求参数时可选

参数解释：

重定向请求时使用的域名。

默认取值：

无

replaceKeyPrefixWith

str

作为请求参数时可选

参数解释：

重定向请求时使用的对象名前缀。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

replaceKeyWith

str

作为请求参数时可选

参数解释：

重定向请求时使用的对象名。

约束限制：

不可与replaceKeyPrefixWith同时使用。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

httpRedirectCode

int

作为请求参数时可选

参数解释：

重定向请求时响应中的HTTP状态码，详见状态码。

默认取值：

无
support.huaweicloud.com/sdk-python-devg-obs/obs_22_0824.html

华为云11.11 2核1G 2M 云服务器

29元/年

立即注册 领万元上云礼券

抽奖赢11111元免单

续费同价 L实例 2核2G 4M

98元/年

热门域名 1元 随心购

1元/年

看了此文的人还看了
CDN加速 GaussDB 文字转换成语音 免费的服务器 如何创建网站 域名网站购买 私有云桌面 云主机哪个好 域名怎么备案 手机云电脑 SSL证书申请 云点播服务器 免费OCR是什么 电脑云桌面 域名备案怎么弄 语音转文字 文字图片识别 云桌面是什么 网址安全检测 网站建设搭建 国外CDN加速 SSL免费证书申请 短信批量发送 图片OCR识别 云数据库MySQL 个人域名购买 录音转文字 扫描图片识别文字 OCR图片识别 行驶证识别 虚拟电话号码 电话呼叫中心软件 怎么制作一个网站 Email注册网站 华为VNC 图像文字识别 企业网站制作 个人网站搭建 华为云计算 免费租用云托管 云桌面云服务器 ocr文字识别免费版 HTTPS证书申请 图片文字识别转换 国外域名注册商 使用免费虚拟主机 云电脑主机多少钱 鲲鹏云手机 短信验证码平台 OCR图片文字识别 SSL证书是什么 申请企业邮箱步骤 免费的企业用邮箱 云免流搭建教程 域名价格
热门活动
对象存储服务 OBS-设置桶的Website配置(Python SDK):请求参数说明

搜索反馈

您搜索到想要的结果了吗?

是的 没有

意见反馈

0/200

提交 取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好 反馈提交失败！请稍后重试！
产品专区
推荐文章
更多内容
云硬盘存储EVS Web应用防火墙 人机语音识别 云计算入门 云数据库选择 HDC大会 华为云计算 响应式建站是什么 智慧班牌系统