更新时间:2024-01-26 GMT+08:00
分享

获取托管配置(Java SDK)

功能介绍

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

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

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

开发过程中,您有任何问题可以在github上提交issue,或者在华为云对象存储服务论坛中发帖求助。

接口约束

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

方法定义

obsClient.getBucketWebsite(final BaseBucketRequest request)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

request

BaseBucketRequest

必选

参数解释

桶基本信息参数列表,详见BaseBucketRequest

表2 BaseBucketRequest

参数名称

参数类型

是否必选

描述

bucketName

String

必选

参数解释

桶名。

约束限制:

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

默认取值:

返回结果说明

表3 WebsiteConfiguration

参数名称

参数类型

是否必选

描述

suffix

String

可选

参数解释:

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

取值范围:

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

默认取值:

key

String

可选

参数解释:

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

取值范围:

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

默认取值:

redirectAllRequestsTo

RedirectAllRequest

可选

参数解释:

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

routeRules

List<RouteRule>

可选

参数解释:

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

表4 RedirectAllRequest

参数名称

参数类型

是否必选

描述

hostName

String

必选

参数解释:

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

约束限制:

域名需符合域名规范。

默认取值:

protocol

ProtocolEnum

可选

参数解释:

重定向时使用的协议。

取值范围:

详见ProtocolEnum

默认取值:

表5 ProtocolEnum

常量名

原始值

说明

HTTP

http

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

HTTPS

https

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

表6 RouteRule

参数名称

参数类型

是否必选

描述

condition

RouteRuleCondition

可选

参数解释:

重定向规则的匹配条件。详见RouteRuleCondition

redirect

Redirect

必选

参数解释:

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

表7 RouteRuleCondition

参数名称

参数类型

是否必选

描述

keyPrefixEquals

String

可选

参数解释:

重定向生效时的对象名前缀。当向对象发送请求时,如果对象名前缀等于这个值,那么重定向生效。

例如:重定向ExamplePage.html对象的请求,keyPrefixEquals设为ExamplePage.html。

约束限制:

与httpErrorCodeReturnedEquals参数不可同时使用,两者二选一。

取值范围:

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

默认取值:

httpErrorCodeReturnedEquals

String

可选

参数解释:

重定向生效时的HTTP错误码。当发生错误时,如果错误码等于这个值,那么重定向生效。

例如:当返回的HTTP错误码为404时重定向到NotFound.html,可以将RouteRuleCondition中的httpErrorCodeReturnedEquals设置为404,Redirect中的replaceKeyWith设置为NotFound.html。

约束限制:

与keyPrefixEquals参数不可同时使用,两者二选一。

取值范围:

取值范围可参见错误码

默认取值:

表8 Redirect

参数名称

参数类型

是否必选

描述

Protocol

ProtocolEnum

可选

参数解释:

重定向时使用的协议。

取值范围:

详见ProtocolEnum

默认取值:

hostName

String

可选

参数解释:

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

默认取值:

replaceKeyPrefixWith

String

可选

参数解释:

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

约束限制:

不可与replaceKeyWith同时使用。

取值范围:

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

默认取值:

replaceKeyWith

String

可选

参数解释:

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

约束限制:

不可与replaceKeyPrefixWith同时使用。

取值范围:

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

默认取值:

httpRedirectCode

String

可选

参数解释:

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

默认取值:

代码示例

您可以通过obsClient.getBucketWebsite查看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
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.RouteRule;
import com.obs.services.model.WebsiteConfiguration;
public class GetBucketWebsite001
{
    public static void main(String[] args) {
        // 您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。
        // 您可以登录访问管理控制台获取访问密钥AK/SK
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。
        // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken,也可以使用其他外部引入方式传入。
        // String securityToken = System.getenv("SECURITY_TOKEN");
        // endpoint填写桶所在的endpoint, 此处以华北-北京四为例,其他地区请按实际情况填写。
        String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
        // 您可以通过环境变量获取endPoint,也可以使用其他外部引入方式传入。
        //String endPoint = System.getenv("ENDPOINT");
        
        // 创建ObsClient实例
        // 使用永久AK/SK初始化客户端
        ObsClient obsClient = new ObsClient(ak, sk,endPoint);
        // 使用临时AK/SK和SecurityToken初始化客户端
        // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);

        try {
            // 查看桶的托管配置
            WebsiteConfiguration config = obsClient.getBucketWebsite("examplebucket");
            System.out.println("Key:" + config.getKey());
            System.out.println("Suffix:" + config.getSuffix());
            for(RouteRule rule : config.getRouteRules()){
                System.out.println("rule:" +rule);
            }
            System.out.println("getBucketWebsite successfully");
        } catch (ObsException e) {
            System.out.println("getBucketWebsite failed");
            // 请求失败,打印http状态码
            System.out.println("HTTP Code:" + e.getResponseCode());
            // 请求失败,打印服务端错误码
            System.out.println("Error Code:" + e.getErrorCode());
            // 请求失败,打印详细错误信息
            System.out.println("Error Message:" + e.getErrorMessage());
            // 请求失败,打印请求id
            System.out.println("Request ID:" + e.getErrorRequestId());
            System.out.println("Host ID:" + e.getErrorHostId());
            e.printStackTrace();
        } catch (Exception e) {
            System.out.println("getBucketWebsite failed");
            // 其他异常信息打印
            e.printStackTrace();
        }
    }
}

相关链接

分享:

    相关文档

    相关产品