九游平台/ 对象存储服务 obs/ sdk参考/ node.js/ / 设置托管配置(node.js sdk)
更新时间：2024-10-11 gmt 08:00

设置托管配置(node.js sdk)-九游平台

开发过程中，您有任何问题可以在github上，或者在中发帖求助。

功能介绍

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

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

调用设置桶的网站配置接口，您可以为指定桶设置网站配置信息。

接口约束

  • 尽量避免目标桶名中带有“.”，否则通过https访问时可能出现客户端校验证书出错。
  • 设置桶的网站配置请求消息体的上限是10kb。
  • 您必须是桶拥有者或拥有设置桶的网站配置的权限，才能设置桶的网站配置。建议使用iam或桶策略进行授权，如果使用iam则需授予obs:bucket:putbucketwebsite权限，如果使用桶策略则需授予putbucketwebsite权限。相关授权方式介绍可参见obs权限控制概述，配置方式详见、。
  • obs支持的region与endpoint的对应关系，详细信息请参见。

方法定义

obsclient.setbucketwebsite(params)

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

bucket

string

必选

参数解释：

桶名。

约束限制：

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

取值范围：

长度为3～63个字符。

默认取值：

无

redirectallrequeststo

redirectallrequestto

可选

参数解释：

所有请求重定向规则。

约束限制：

无

取值范围：

详见redirectallrequestto。

默认取值：

无

indexdocument

indexdocument

可选

参数解释：

默认页面配置。

约束限制：

无

取值范围：

详见indexdocument。

默认取值：

无

errordocument

errordocument

可选

参数解释：

错误页面配置。

约束限制：

无

取值范围：

详见errordocument。

默认取值：

无

routingrules

routingrule[]

可选

参数解释：

请求重定向规则列表。

约束限制：

无

取值范围：

详见routingrule。

默认取值：

无
  • errordocument、indexdocument和routingrules必须配套使用，且与redirectallrequeststo互斥。当设置了这三个字段时，不能设置redirectallrequeststo；反之，当设置了redirectallrequeststo时，不能设置errordocument、indexdocument和routingrules。
  • 当errordocument、indexdocument和routingrules三个字段一起使用时，routingrules可为空。
  • errordocument、indexdocument、routingrules与redirectallrequeststo不能全为空。
表2 redirectallrequeststo

参数名称

参数类型

是否必选

描述

hostname

string

如果redirectallrequeststo设置必选

参数解释：

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

约束限制：

域名需符合域名规范。

取值范围：

无

默认取值：

无

protocol

string

可选

参数解释：

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

约束限制：

无

取值范围：

协议类型可选：http、https。

默认取值：

无
表3 indexdocument

参数名称

参数类型

是否必选

描述

suffix

string

如果indexdocument 设置则参数时必选

参数解释：

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

约束限制：

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

取值范围：

无

默认取值：

无
表4 errordocument

参数名称

参数类型

是否必选

描述

key

string

如果errordocument 设置时可选

参数解释：

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

约束限制：

无

取值范围：

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

默认取值：

无
表5 routingrule

参数名称

参数类型

是否必选

描述

condition

condition

可选

参数解释：

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

约束限制：

无

取值范围：

匹配条件选择范围详见condition。

默认取值：

无

redirect

redirect

如果routingrule 设置则参数时必选

参数解释：

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

约束限制：

无

取值范围：

详见redirect。

默认取值：

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

取值范围：

取值范围可参见错误码。

默认取值：

无
表7 redirect

参数名称

参数类型

是否必选

描述

protocol

string

作为请求参数时可选

参数解释：

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

约束限制：

无

取值范围：

协议类型可选范围：http、https。

默认取值：

无

hostname

string

作为请求参数时可选

参数解释：

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

约束限制：

域名需符合域名规范。

取值范围：

无

默认取值：

无

replacekeyprefixwith

string

作为请求参数时可选

参数解释：

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

约束限制：

无

取值范围：

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

默认取值：

无

replacekeywith

string

作为请求参数时可选

参数解释：

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

约束限制：

不可与replacekeyprefixwith同时使用。

取值范围：

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

默认取值：

无

httpredirectcode

string

作为请求参数时可选

参数解释：

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

约束限制：

无

取值范围：

详见。

默认取值：

无

返回结果

表8 返回结果

参数类型

描述

表9

说明：

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

参数解释：

接口返回信息，详见

表9。
表9 response

参数名称

参数类型

描述

commonmsg

icommonmsg

参数解释：

接口调用完成后的公共信息，包含http状态码，操作失败的错误码等，详见icommonmsg。

interfaceresult

表11

参数解释：

操作成功后的结果数据，详见表11。

约束限制：

当status大于300时为空。
表10 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服务端返回的详细错误码。
表11 baseresponseoutput

参数名称

参数类型

描述

requestid

string

参数解释：

obs服务端返回的请求id。

代码示例

本示例用于设置名为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
 
// 引入obs库
// 使用npm安装
constobsclient=require("esdk-obs-nodejs");
// 使用源码安装
// var obsclient = require('./lib/obs');
// 创建obsclient实例
constobsclient=newobsclient({
// 推荐通过环境变量获取aksk，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
// 您可以登录访问管理控制台获取访问密钥ak/sk，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
access_key_id:process.env.access_key_id,
secret_access_key:process.env.secret_access_key,
// 【可选】如果使用临时ak/sk和securitytoken访问obs，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥ak/sk，也可以使用其他外部引入方式传入。
// security_token: process.env.security_token,
// endpoint填写bucket对应的endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写。
server:"https://obs.cn-north-4.myhuaweicloud.com",
});
asyncfunctionsetbucketwebsite(){
try{
constparams={
// 指定存储桶名称
bucket:"examplebucket",
// 指定默认页面配置，此处以index.html为例
indexdocument:{suffix:'index.html'},
// 指定错误页面配置，此处以error.html为例
errordocument:{key:'error.html'},
// 指定所有请求重定向
redirectallrequeststo:{hostname:'www.example.com',protocol:'http'}
// 指定请求重定向规则列表
routingrules:[
{redirect:{hostname:"www.a.com",protocol:obs.protocolhttp,replacekeyprefixwith:"prefix",httpredirectcode:"304"}},
{redirect:{hostname:"www.b.com",protocol:obs.protocolhttps,replacekeywith:"replacekey",httpredirectcode:"304"}},
]
};
// 设置桶的website配置
constresult=awaitobsclient.setbucketwebsite(params);
if(result.commonmsg.status<=300){
console.log("set bucket(%s)'s website configuration successful!",params.bucket);
console.log("requestid: %s",result.commonmsg.requestid);
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);
};
};
setbucketwebsite();
父主题：

相关文档

网站地图