对象存储服务 OBS-获取桶的Website配置(Harmony SDK):返回结果
返回结果
参数类型 |
描述 |
---|---|
说明:
该接口返回是一个Promise类型,需要使用Promise、async/await语法处理。 |
参数解释: 接口返回信息,详见Response。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
CommonMsg |
参数解释: 接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等,详见ICommonMsg。 |
|
InterfaceResult |
参数解释: 操作成功后的结果数据,详见GetBucketWebsiteOutput。 约束限制: 当Status大于300时为空。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
Status |
number |
参数解释: OBS服务端返回的HTTP状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 |
Code |
string |
参数解释: OBS服务端返回的错误码。 |
Message |
string |
参数解释: OBS服务端返回的错误描述。 |
HostId |
string |
参数解释: OBS服务端返回的请求服务端ID。 |
RequestId |
string |
参数解释: OBS服务端返回的请求ID。 |
Id2 |
string |
参数解释: OBS服务端返回的请求ID2。 |
Indicator |
string |
参数解释: OBS服务端返回的详细错误码。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
RequestId |
string |
参数解释: OBS服务端返回的请求ID。 默认取值: 无 |
RedirectAllRequestsTo |
参数解释: 所有请求重定向规则,详见RedirectAllRequestTo。 |
|
IndexDocument |
可选 参数解释: 默认页面配置,详见IndexDocument。 |
|
ErrorDocument |
可选 参数解释: 错误页面配置,详见ErrorDocument。 |
|
RoutingRules |
可选 参数解释: 请求重定向规则列表,详见RoutingRule。 |
参数名称 |
参数类型 |
是否可选 |
描述 |
---|---|---|---|
HostName |
string |
如果RedirectAllRequestsTo 设置必选 |
参数解释: 重定向时使用的 域名 。如 www.example.com。 约束限制: 域名需符合域名规范。 默认取值: 无 |
Protocol |
string |
可选 |
参数解释: 重定向请求时使用的协议。 取值范围: 协议类型可选:http、https。 默认取值: 无 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
Suffix |
string |
如果IndexDocument 设置则参数时必选 |
参数解释: 该字段被追加在对文件夹的请求的末尾(例如:Suffix参数设置为“index.html”,请求的是“samplebucket/images/”,返回的数据将是“samplebucket”桶内名为“images/index.html”的对象的内容)。 取值范围: 该字段不能为空或者包含“/”字符。 默认取值: 无 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
Key |
string |
如果ErrorDocument 设置时可选 |
参数解释: 当4XX错误出现时使用的对象的名称。这个元素指定当错误出现时返回的页面。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
参数名称 |
参数类型 |
是否可选 |
描述 |
---|---|---|---|
Condition |
可选 |
参数解释: 重定向规则生效需要满足的条件。 取值范围: 匹配条件选择范围详见Condition。 默认取值: 无 |
|
Redirect |
如果RoutingRule 设置则参数时必选 |
参数解释: 重定向请求时的具体信息,详见Redirect。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
KeyPrefixEquals |
string |
可选 |
参数解释: 重定向生效时的对象名前缀。当向对象发送请求时,如果对象名前缀等于这个值,那么重定向生效。 例如:重定向ExamplePage.html对象的请求,KeyPrefixEquals设为ExamplePage.html。 约束限制: 与HttpErrorCodeReturnedEquals参数不可同时使用,两者二选一。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
HttpErrorCodeReturnedEquals |
string |
可选 |
参数解释: 重定向生效时的HTTP错误码。当发生错误时,如果错误码等于这个值,那么重定向生效。 例如:当返回的HTTP错误码为404时重定向到NotFound.html,可以将Condition中的HttpErrorCodeReturnedEquals设置为404,Redirect中的ReplaceKeyWith设置为NotFound.html。 约束限制: 与KeyPrefixEquals参数不可同时使用,两者二选一。 取值范围: 可参见错误码。 默认取值: 无 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
Protocol |
string |
作为请求参数时可选 |
参数解释: 重定向请求时使用的协议。 取值范围: 协议类型可选范围:http、https。 默认取值: 无 |
HostName |
string |
作为请求参数时可选 |
参数解释: 重定向请求时使用的域名。 默认取值: 无 |
ReplaceKeyPrefixWith |
string |
作为请求参数时可选 |
参数解释: 重定向请求时使用的对象名前缀。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
ReplaceKeyWith |
string |
作为请求参数时可选 |
参数解释: 重定向请求时使用的对象名。 约束限制: 不可与ReplaceKeyPrefixWith同时使用。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
HttpRedirectCode |
string |
作为请求参数时可选 |
参数解释: 重定向请求时响应中的HTTP状态码,详见状态码。 默认取值: 无 |