更新时间:2025-12-04 GMT+08:00
分享

获取桶的Website配置

功能说明

获取桶的Website配置。

方法定义

ObsClient.getBucketWebsite

请求参数

字段名

类型

约束

说明

Bucket

String

必选

桶名。

RequestDate

String

Date

可选

指定请求时间。

说明:

当为String类型时,必须符合ISO8601或RFC822规范。

返回结果(InterfaceResult)

字段名

类型

说明

RequestId

String

OBS服务端返回的请求ID。

RedirectAllRequestsTo

Object

所有请求重定向的规则。

-

HostName

String

重定向时使用的站点名。

Protocol

String

重定向时使用的协议。

ErrorDocument

Object

错误页面配置。

-

Key

String

指定当4XX错误出现时返回的页面。

IndexDocument

Object

默认页面配置。

-

Suffix

String

该字段被追加在对文件夹的请求的末尾(例如:配置的是“index.html”,请求的是“samplebucket/images/”,返回的数据将是“samplebucket”桶内名为“images/index.html”的对象的内容)。该字段不能为空或者包含“/”字符。

RoutingRules

Array

重定向规则列表。

-

Condition

Object

重定向规则的匹配条件。

-

HttpErrorCodeReturnedEquals

String

重定向规则生效需要匹配的HTTP错误码。

KeyPrefixEquals

String

重定向规则生效需要匹配的对象名前缀。

Redirect

Object

重定向请求时的具体信息。

-

Protocol

String

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

HostName

String

重定向请求时使用的站点名。

ReplaceKeyPrefixWith

String

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

ReplaceKeyWith

String

重定向请求时使用的对象名。不可与ReplaceKeyPrefixWith同时存在。

HttpRedirectCode

String

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

代码样例

obsClient.getBucketWebsite({
       Bucket : 'bucketname'
},function (err, result) {
       if(err){
              console.error('Error-->' + err);
       }else{
              if(result.CommonMsg.Status < 300){
                     console.log('RequestId-->' + result.InterfaceResult.RequestId);
                     console.log('RedirectAllRequestsTo:');
                     console.log('HostName-->' + result.InterfaceResult.RedirectAllRequestsTo['HostName']);
                     console.log('Protocol-->' + result.InterfaceResult.RedirectAllRequestsTo['Protocol']);
                     console.log('IndexDocument[Suffix]-->' + result.InterfaceResult.IndexDocument['Suffix']);
                     console.log('ErrorDocument[Key]-->' + result.InterfaceResult.ErrorDocument['Key']);
                     console.log('RoutingRules:');
                     for(var i=0;i<result.InterfaceResult.RoutingRules.length;i++){
                           console.log('RoutingRule[' + i + ']:');
                           var RoutingRule = result.InterfaceResult.RoutingRules[i];
                           console.log('Condition[HttpErrorCodeReturnedEquals]-->' + RoutingRule['Condition']['HttpErrorCodeReturnedEquals']);
                           console.log('Condition[KeyPrefixEquals]-->' + RoutingRule['Condition']['KeyPrefixEquals']);
                           console.log('Redirect[HostName]-->' + RoutingRule['Redirect']['HostName']);
                           console.log('Redirect[HttpRedirectCode]-->' + RoutingRule['Redirect']['HttpRedirectCode']);
                           console.log('Redirect[Protocol]-->' + RoutingRule['Redirect']['Protocol']);
                           console.log('Redirect[ReplaceKeyPrefixWith]-->' + RoutingRule['Redirect']['ReplaceKeyPrefixWith']);
                           console.log('Redirect[ReplaceKeyWith]-->' + RoutingRule['Redirect']['ReplaceKeyWith']);
                     }
              }else{
                     console.log('Code-->' + result.CommonMsg.Code);
                     console.log('Message-->' + result.CommonMsg.Message);
              }
       }
});

相关文档