设置托管配置(java sdk)-九游平台
功能介绍
obs允许在桶内保存静态的网页资源,如.html网页文件、flash文件、音视频文件等,当客户端通过桶的website接入点访问这些对象资源时,浏览器可以直接解析出这些支持的网页资源,呈现给最终用户。典型的应用场景有:
- 重定向所有的请求到另外一个站点。
- 设定特定的重定向规则来重定向特定的请求。
调用设置桶的网站配置接口,您可以为指定桶设置网站配置信息。

开发过程中,您有任何问题可以在github上,或者在中发帖求助。
接口约束
- 尽量避免目标桶名中带有“.”,否则通过https访问时可能出现客户端校验证书出错。
- 设置桶的网站配置请求消息体的上限是10kb。
- 您必须是桶拥有者或拥有设置桶的网站配置的权限,才能设置桶的网站配置。建议使用iam或桶策略进行授权,如果使用iam则需授予obs:bucket:putbucketwebsite权限,如果使用桶策略则需授予putbucketwebsite权限。相关授权方式介绍可参见obs权限控制概述,配置方式详见、。
- obs支持的region以及region与endpoint的对应关系,详细信息请参见。
方法定义
obsclient.setbucketwebsite(final setbucketwebsiterequest request)
请求参数说明
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
request |
必选 |
参数解释: 设置托管配置请求参数,详见setbucketwebsiterequest。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
bucketname |
string |
必选 |
参数解释: 桶名。 约束限制:
取值范围: 长度为3~63个字符。 |
websiteconfig |
必选 |
参数解释: 静态网站设置托管配置信息,详见websiteconfiguration。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
suffix |
string |
可选 |
参数解释: 该字段被追加在对文件夹的请求的末尾(例如:suffix参数设置为“index.html”,请求的是“samplebucket/images/”,返回的数据将是“samplebucket”桶内名为“images/index.html”的对象的内容)。 约束限制:
取值范围: 该字段不能为空或者包含“/”字符。 默认取值: 无 |
key |
string |
可选 |
参数解释: 当4xx错误出现时使用的对象的名称。这个元素指定当错误出现时返回的页面。 约束限制:
取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
routerules |
list<routerule> |
可选 |
参数解释: 请求重定向规则列表,详见routerule。 约束限制:
默认取值: 无 |
redirectallrequeststo |
可选 |
参数解释: 所有请求重定向规则,详见redirectallrequest。 约束限制:
默认取值: 无 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
hostname |
string |
必选 |
参数解释: 重定向时使用的域名。如 www.example.com。 约束限制: 域名需符合域名规范。 默认取值: 无 |
protocol |
可选 |
参数解释: 重定向时使用的协议。 取值范围: 详见protocolenum。 默认取值: 无 |
常量名 |
原始值 |
说明 |
---|---|---|
http |
http |
重定向请求时使用http协议。 |
https |
https |
重定向请求时使用https协议。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
condition |
可选 |
参数解释: 重定向规则的匹配条件。详见routerulecondition。 |
|
redirect |
必选 |
参数解释: 重定向请求时的具体信息。详见redirect。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
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参数不可同时使用,两者二选一。 取值范围: 取值范围可参见错误码。 默认取值: 无 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
protocol |
可选 |
参数解释: 重定向时使用的协议。 取值范围: 详见protocolenum。 默认取值: 无 |
|
hostname |
string |
可选 |
参数解释: 重定向请求时使用的域名。 默认取值: 无 |
replacekeyprefixwith |
string |
可选 |
参数解释: 重定向请求时使用的对象名前缀。 约束限制: 不可与replacekeywith同时使用。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
replacekeywith |
string |
可选 |
参数解释: 重定向请求时使用的对象名。 约束限制: 不可与replacekeyprefixwith同时使用。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
httpredirectcode |
string |
可选 |
参数解释: 重定向请求时响应中的http状态码,详见。 默认取值: 无 |
返回结果说明
参数名称 |
参数类型 |
描述 |
---|---|---|
statuscode |
int |
参数解释: http状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。 完整的状态码列表请参见。 默认取值: 无 |
responseheaders |
map |
参数解释: http响应消息头列表,由多个元组构成。元组中string代表响应消息头的名称,object代表响应消息头的值。 默认取值: 无 |
代码示例:配置默认九游平台主页和错误页面
以下代码展示了如何为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 |
importcom.obs.services.obsclient; importcom.obs.services.exception.obsexception; importcom.obs.services.model.websiteconfiguration; publicclass setbucketwebsite001 { publicstaticvoidmain(string[]args){ // 您可以通过环境变量获取访问密钥ak/sk,也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥ak/sk stringak=system.getenv("access_key_id"); stringsk=system.getenv("secret_access_key_id"); // 【可选】如果使用临时ak/sk和securitytoken访问obs,同样建议您尽量避免使用硬编码,以降低信息泄露风险。 // 您可以通过环境变量获取访问密钥ak/sk/securitytoken,也可以使用其他外部引入方式传入。 stringsecuritytoken=system.getenv("security_token"); // endpoint填写桶所在的endpoint, 此处以华北-北京四为例,其他地区请按实际情况填写。 stringendpoint="https://obs.cn-north-4.myhuaweicloud.com"; // 您可以通过环境变量获取endpoint,也可以使用其他外部引入方式传入。 //string endpoint = system.getenv("endpoint"); // 创建obsclient实例 // 使用永久ak/sk初始化客户端 obsclientobsclient=newobsclient(ak,sk,endpoint); // 使用临时ak/sk和securitytoken初始化客户端 // obsclient obsclient = new obsclient(ak, sk, securitytoken, endpoint); try{ // 以下代码展示了如何配置默认九游平台主页和错误页面 websiteconfigurationconfig=newwebsiteconfiguration(); // 配置默认九游平台主页 config.setsuffix("index.html"); // 配置错误页面 config.setkey("error.html"); obsclient.setbucketwebsite("examplebucket",config); system.out.println("setbucketwebsite successfully"); }catch(obsexceptione){ system.out.println("setbucketwebsite 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(exceptione){ system.out.println("setbucketwebsite failed"); // 其他异常信息打印 e.printstacktrace(); } } } |
代码示例:配置重定向规则
以下代码展示了如何为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 58 59 60 61 62 63 64 65 66 67 68 |
importcom.obs.services.obsclient; importcom.obs.services.exception.obsexception; importcom.obs.services.model.protocolenum; importcom.obs.services.model.redirect; importcom.obs.services.model.routerule; importcom.obs.services.model.routerulecondition; importcom.obs.services.model.websiteconfiguration; publicclass setbucketwebsite002 { publicstaticvoidmain(string[]args){ // 您可以通过环境变量获取访问密钥ak/sk,也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥ak/sk stringak=system.getenv("access_key_id"); stringsk=system.getenv("secret_access_key_id"); // 【可选】如果使用临时ak/sk和securitytoken访问obs,同样建议您尽量避免使用硬编码,以降低信息泄露风险。 // 您可以通过环境变量获取访问密钥ak/sk/securitytoken,也可以使用其他外部引入方式传入。 // string securitytoken = system.getenv("security_token"); // endpoint填写桶所在的endpoint, 此处以华北-北京四为例,其他地区请按实际情况填写。 stringendpoint="https://obs.cn-north-4.myhuaweicloud.com"; // 您可以通过环境变量获取endpoint,也可以使用其他外部引入方式传入。 //string endpoint = system.getenv("endpoint"); // 创建obsclient实例 // 使用永久ak/sk初始化客户端 obsclientobsclient=newobsclient(ak,sk,endpoint); // 使用临时ak/sk和securitytoken初始化客户端 // obsclient obsclient = new obsclient(ak, sk, securitytoken, endpoint); try{ // 以下代码展示了如何配置重定向规则 websiteconfigurationconfig=newwebsiteconfiguration(); // 配置默认九游平台主页 config.setsuffix("index.html"); // 配置错误页面 config.setkey("error.html"); routerulerule=newrouterule(); redirectr=newredirect(); r.sethostname("www.example.com"); r.sethttpredirectcode("305"); r.setredirectprotocol(protocolenum.http); r.setreplacekeyprefixwith("replacekeyprefix"); rule.setredirect(r); routeruleconditioncondition=newrouterulecondition(); condition.sethttperrorcodereturnedequals("404"); condition.setkeyprefixequals("keyprefix"); rule.setcondition(condition); config.getrouterules().add(rule); obsclient.setbucketwebsite("examplebucket",config); system.out.println("setbucketwebsite successfully"); }catch(obsexceptione){ system.out.println("setbucketwebsite 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(exceptione){ system.out.println("setbucketwebsite failed"); // 其他异常信息打印 e.printstacktrace(); } } } |
代码示例:配置所有请求重定向
以下代码展示了如何为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 |
importcom.obs.services.obsclient; importcom.obs.services.exception.obsexception; importcom.obs.services.model.protocolenum; importcom.obs.services.model.redirectallrequest; importcom.obs.services.model.websiteconfiguration; publicclass setbucketwebsite003 { publicstaticvoidmain(string[]args){ // 您可以通过环境变量获取访问密钥ak/sk,也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥ak/sk stringak=system.getenv("access_key_id"); stringsk=system.getenv("secret_access_key_id"); // 【可选】如果使用临时ak/sk和securitytoken访问obs,同样建议您尽量避免使用硬编码,以降低信息泄露风险。 // 您可以通过环境变量获取访问密钥ak/sk/securitytoken,也可以使用其他外部引入方式传入。 // string securitytoken = system.getenv("security_token"); // endpoint填写桶所在的endpoint, 此处以华北-北京四为例,其他地区请按实际情况填写。 stringendpoint="https://obs.cn-north-4.myhuaweicloud.com"; // 您可以通过环境变量获取endpoint,也可以使用其他外部引入方式传入。 //string endpoint = system.getenv("endpoint"); // 创建obsclient实例 // 使用永久ak/sk初始化客户端 obsclientobsclient=newobsclient(ak,sk,endpoint); // 使用临时ak/sk和securitytoken初始化客户端 // obsclient obsclient = new obsclient(ak, sk, securitytoken, endpoint); try{ // 以下代码展示了如何配置所有请求重定向 websiteconfigurationconfig=newwebsiteconfiguration(); redirectallrequestredirectall=newredirectallrequest(); redirectall.sethostname("www.example.com"); redirectall.setredirectprotocol(protocolenum.http); config.setredirectallrequeststo(redirectall); obsclient.setbucketwebsite("examplebucket",config); system.out.println("setbucketwebsite successfully"); }catch(obsexceptione){ system.out.println("setbucketwebsite 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(exceptione){ system.out.println("setbucketwebsite failed"); // 其他异常信息打印 e.printstacktrace(); } } } |
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨