更新时间:2024-11-19 GMT+08:00
分享

获取桶的Website配置(Harmony SDK)

功能介绍

OBS允许在桶内保存静态的网页资源,如.html网页文件、flash文件、音视频文件等,当客户端通过桶的Website接入点访问这些对象资源时,浏览器可以直接解析出这些支持的网页资源,呈现给最终用户。典型的应用场景有:

  • 重定向所有的请求到另外一个站点。
  • 设定特定的重定向规则来重定向特定的请求。

调用获取桶的网站配置接口,您可以获取指定桶的网站配置信息。

接口约束

  • 您必须是桶拥有者或拥有获取桶的网站配置的权限,才能获取桶的网站配置。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:GetBucketWebsite权限,如果使用桶策略则需授予GetBucketWebsite权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略自定义创建桶策略
  • OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点

方法定义

getBucketWebsite(input: BucketRequestInput): Response<GetBucketWebsiteOutput>

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

input

BucketRequestInput

必选

参数解释:

获取桶的网站配置接口接口入参,详见

BucketRequestInput

表2 BucketRequestInput

参数名称

参数类型

是否必选

描述

Bucket

string

必选

参数解释

桶名。

约束限制:

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

默认取值:

返回结果

表3 返回结果

参数类型

描述

Response

说明:

该接口返回是一个Promise类型,需要使用Promise、async/await语法处理。

参数解释:

接口返回信息,详见Response

表4 Response

参数名称

参数类型

描述

CommonMsg

ICommonMsg

参数解释:

接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等,详见ICommonMsg

InterfaceResult

GetBucketWebsiteOutput

参数解释:

操作成功后的结果数据,详见GetBucketWebsiteOutput

约束限制:

当Status大于300时为空。

表5 ICommonMsg

参数名称

参数类型

描述

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服务端返回的详细错误码。

表6 GetBucketWebsiteOutput

参数名称

参数类型

描述

RequestId

string

参数解释:

OBS服务端返回的请求ID。

默认取值:

RedirectAllRequestsTo

RedirectAllRequestTo

参数解释:

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

IndexDocument

IndexDocument

可选

参数解释:

默认页面配置,详见IndexDocument

ErrorDocument

ErrorDocument

可选

参数解释:

错误页面配置,详见ErrorDocument

RoutingRules

RoutingRule[]

可选

参数解释:

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

表7 RedirectAllRequestsTo

参数名称

参数类型

是否可选

描述

HostName

string

如果RedirectAllRequestsTo 设置必选

参数解释:

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

约束限制:

域名需符合域名规范

默认取值:

Protocol

string

可选

参数解释:

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

取值范围:

协议类型可选:http、https

默认取值:

表8 IndexDocument

参数名称

参数类型

是否必选

描述

Suffix

string

如果IndexDocument 设置则参数时必选

参数解释:

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

取值范围:

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

默认取值:

表9 ErrorDocument

参数名称

参数类型

是否必选

描述

Key

string

如果ErrorDocument 设置时可选

参数解释:

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

取值范围:

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

默认取值:

表10 RoutingRule

参数名称

参数类型

是否可选

描述

Condition

Condition

可选

参数解释:

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

取值范围:

匹配条件选择范围详见Condition

默认取值:

Redirect

Redirect

如果RoutingRule 设置则参数时必选

参数解释:

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

表11 Condition

参数名称

参数类型

是否必选

描述

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

取值范围:

可参见错误码

默认取值:

表12 Redirect

参数名称

参数类型

是否必选

描述

Protocol

string

作为请求参数时可选

参数解释:

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

取值范围:

协议类型可选范围:http、https

默认取值:

HostName

string

作为请求参数时可选

参数解释:

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

默认取值:

ReplaceKeyPrefixWith

string

作为请求参数时可选

参数解释:

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

取值范围:

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

默认取值:

ReplaceKeyWith

string

作为请求参数时可选

参数解释:

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

约束限制:

不可与replaceKeyPrefixWith同时使用。

取值范围:

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

默认取值:

HttpRedirectCode

string

作为请求参数时可选

参数解释:

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

默认取值:

代码示例

本示例用于获取名为examplebucket桶的网站配置。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
// 引入依赖包
import ObsClient, { BucketRequestInput } from '@obs/esdk-obs-harmony';

// 创建ObsClient实例
const obsClient = new ObsClient({
  // 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险
  // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
  AccessKeyId: process.env.ACCESS_KEY_ID,
  SecretAccessKey: process.env.SECRET_ACCESS_KEY,
  // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入
  // SecurityToken: process.env.SECURITY_TOKEN,
  // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写
  Server: "https://obs.cn-north-4.myhuaweicloud.com",
});

async function getBucketWebsite() {
  try {
    const params: BucketRequestInput = {
      // 指定存储桶名称
      Bucket: "examplebucket",
    };
    // 获取桶的网站配置
    const result = await obsClient.getBucketWebsite(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Get bucket(%s)'s website configuration successful!", params.Bucket);
      console.log('RedirectAllRequestsTo:');
      console.log('HostName: %s', result.InterfaceResult.RedirectAllRequestsTo.HostName);
      console.log('Protocol: %s', result.InterfaceResult.RedirectAllRequestsTo.Protocol);
      console.log('IndexDocument[Suffix]: %s', result.InterfaceResult.IndexDocument.Suffix);
      console.log('ErrorDocument[Key]: %s', result.InterfaceResult.ErrorDocument.Key);
      console.log('RoutingRules:');
      for (let i = 0; i < result.InterfaceResult.RoutingRules; i++) {
        let routingRule = result.InterfaceResult.RoutingRules[i];
        let condition = routingRule.Condition;
        console.log("Condition[%d]-KeyPrefixEquals:%s, HttpErrorCodeReturnedEquals:%s",
          i, condition.KeyPrefixEquals, condition.HttpErrorCodeReturnedEquals
        );
        let redirect = routingRule.Redirect;
        console.log("Redirect[%d]-Protocol:%s, HostName:%s, ReplaceKeyPrefixWith:%s, HttpRedirectCode:%s",
          i, redirect.Protocol, redirect.HostName, redirect.ReplaceKeyPrefixWith, redirect.HttpRedirectCode
        );
      }
      return;
    }
    
    console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
    console.log("Status: %d", result.CommonMsg.Status);
    console.log("Code: %s", result.CommonMsg.Code);
    console.log("Message: %s", result.CommonMsg.Message);
    console.log("RequestId: %s", result.CommonMsg.RequestId);
  } catch (error) {
    console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.");
    console.log(error);
  }
}

getBucketWebsite();

相关链接

相关文档