对象存储服务 OBS-获取桶的Website配置(Python SDK):返回结果说明

时间:2024-12-24 19:57:17

返回结果说明

类型

说明

GetResult

参数解释:

SDK公共结果对象。

表1 GetResult

参数名称

参数类型

描述

status

int

参数解释:

HTTP状态码。

取值范围:

状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码

默认取值:

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配置。

表2 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不能全为空。
表3 RedirectAllRequestTo

参数名称

参数类型

是否必选

描述

hostName

str

作为请求参数时必选

参数解释:

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

约束限制:

域名需符合域名规范。

默认取值:

protocol

str

作为请求参数时可选

参数解释:

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

取值范围:

  • http
  • https

默认取值:

表4 IndexDocument

参数名称

参数类型

是否必选

描述

suffix

str

作为请求参数时必选

参数解释:

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

取值范围:

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

默认取值:

表5 ErrorDocument

参数名称

参数类型

是否必选

描述

key

str

作为请求参数时可选

参数解释:

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

取值范围:

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

默认取值:

表6 RoutingRule

参数名称

参数类型

是否必选

描述

condition

Condition

作为请求参数时可选

参数解释:

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

取值范围:

匹配条件选择范围详见Condition

默认取值:

redirect

Redirect

作为请求参数时必选

参数解释:

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

默认取值:

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

取值范围:

取值范围可参见错误码

默认取值:

表8 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_0825.html