# 设置桶的Website配置(HarmonyOS SDK) #### 功能说明 OBS允许在桶内保存静态的网页资源，如.html网页文件、flash文件、音视频文件等，当客户端通过桶的Website接入点访问这些对象资源时，浏览器可以直接解析出这些支持的网页资源，呈现给最终用户。典型的应用场景有： - 重定向所有的请求到另外一个站点。 - 设定特定的重定向规则来重定向特定的请求。 调用设置桶的网站配置接口，您可以为指定桶设置网站配置信息。 #### 接口约束 - 尽量避免目标桶名中带有"."，否则通过HTTPS访问时可能出现客户端校验证书出错。 - 设置桶的网站配置请求消息体的上限是10KB。 - 您必须是桶拥有者或拥有设置桶的网站配置的权限，才能设置桶的网站配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketWebsite权限，如果使用桶策略则需授予PutBucketWebsite权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 ``` setBucketWebsite(input: SetBucketWebsiteInput): Response ``` #### 请求参数 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | input | [SetBucketWebsiteInput] | 必选 | **参数解释：** 设置桶的网站配置接口入参，详见[SetBucketWebsiteInput]。 | 表2SetBucketWebsiteInput | **参数名称** | **参数类型** | **是否可选** | **描述** | |:---|:---|:---|:---| | 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]。 | ![](https://support.huaweicloud.com/sdk-harmony-devg-obs/public_sys-resources/note_3.0-zh-cn.png) - ErrorDocument、IndexDocument和RoutingRules必须配套使用，且与RedirectAllRequestsTo互斥。当设置了这三个字段时，不能设置RedirectAllRequestsTo；反之，当设置了RedirectAllRequestsTo时，不能设置ErrorDocument、IndexDocument和RoutingRules。 - 当ErrorDocument、IndexDocument和RoutingRules三个字段一起使用时，RoutingRules可为空。 - ErrorDocument、IndexDocument、RoutingRules与RedirectAllRequestsTo不能全为空。 表3RedirectAllRequestsTo | **参数名称** | **参数类型** | **是否可选** | **描述** | |:---|:---|:---|:---| | HostName | string | 如果设置RedirectAllRequestsTo则必选 | **参数解释：** 重定向时使用的域名。如 www.example.com。 **约束限制：** 域名需符合域名规范。 **默认取值：** 无 | | Protocol | string | 可选 | **参数解释：** 重定向请求时使用的协议。 **取值范围：** 协议类型可选：http、https。 **默认取值：** 无 | 表4IndexDocument | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Suffix | string | 如果IndexDocument 设置则参数时必选 | **参数解释：** 该字段被追加在对文件夹的请求的末尾（例如：Suffix参数设置为"index.html"，请求的是"samplebucket/images/"，返回的数据将是"samplebucket"桶内名为"images/index.html"的对象的内容）。 **取值范围：** 该字段不能为空或者包含"/"字符。 **默认取值：** 无 | 表5ErrorDocument | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Key | string | 如果ErrorDocument 设置时可选 | **参数解释：** 当4XX错误出现时使用的对象的名称。这个元素指定当错误出现时返回的页面。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | 表6RoutingRule | **字段名** | **类型** | **约束** | **说明** | |:---|:---|:---|:---| | Condition | [Condition] | 可选 | **参数解释：** 重定向规则生效需要满足的条件。 **取值范围：** 匹配条件选择范围详见[Condition]。 **默认取值：** 无 | | Redirect | [Redirect] | 如果设置RoutingRule则必选 | **参数解释：** 重定向请求时的具体信息，详见[Redirect]。 | 表7Condition | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | 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参数不可同时使用，两者二选一。 **取值范围：** 可参见[错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html)。 **默认取值：** 无 | 表8Redirect | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Protocol | string | 作为请求参数时可选 | **参数解释：** 重定向请求时使用的协议。 **取值范围：** 协议类型可选范围：http、https。 **默认取值：** 无 | | HostName | string | 作为请求参数时可选 | **参数解释：** 重定向请求时使用的域名。 **默认取值：** 无 | | ReplaceKeyPrefixWith | string | 作为请求参数时可选 | **参数解释：** 重定向请求时使用的对象名前缀。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | ReplaceKeyWith | string | 作为请求参数时可选 | **参数解释：** 重定向请求时使用的对象名。 **约束限制：** 不可与ReplaceKeyPrefixWith同时使用。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | HttpRedirectCode | string | 作为请求参数时可选 | **参数解释：** 重定向请求时响应中的HTTP状态码，详见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | #### 返回结果 表9返回结果 | **参数类型** | **描述** | |:---|:---| | [Response] 说明： 该接口返回一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[Response]。 | 表10Response | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | CommonMsg | [ICommonMsg] | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见[ICommonMsg]。 | | InterfaceResult | [BaseResponseOutput] | **参数解释：** 操作成功后的结果数据，详见[BaseResponseOutput]。 **约束限制：** 当Status大于300时为空。 | 表11ICommonMsg | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | Status | number | **参数解释：** OBS服务端返回的HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 | | Code | string | **参数解释：** OBS服务端返回的错误码。 | | Message | string | **参数解释：** OBS服务端返回的错误描述。 | | HostId | string | **参数解释：** OBS服务端返回的请求服务端ID。 | | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | | Id2 | string | **参数解释：** OBS服务端返回的请求ID2。 | | Indicator | string | **参数解释：** OBS服务端返回的详细错误码。 | 表12BaseResponseOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | | Id2 | string | **参数解释：** OBS服务端返回的请求ID2。 | #### 代码示例 本示例用于设置名为examplebucket桶的网站配置。 ``` // 引入依赖包 import ObsClient, { SetBucketWebsiteInput } from '@obs/esdk-obs-harmony'; import { process } from '@kit.ArkTS'; import { BusinessError } from '@kit.BasicServicesKit'; import { hilog } from '@kit.PerformanceAnalysisKit'; const processManager = new process.ProcessManager(); // 创建ObsClient实例 const obsClient = new ObsClient({ // 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html AccessKeyId: processManager.getEnvironmentVar("ACCESS_KEY_ID"), SecretAccessKey: processManager.getEnvironmentVar("SECRET_ACCESS_KEY"), // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入 // SecurityToken: processManager.getEnvironmentVar("SECURITY_TOKEN"), // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写 Server: "https://obs.cn-north-4.myhuaweicloud.com", }); async function setBucketWebsite() { try { const params: SetBucketWebsiteInput = { // 指定存储桶名称 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: "http", ReplaceKeyPrefixWith: "prefix", HttpRedirectCode: 301 } }, { Redirect: { HostName: "www.b.com", Protocol: "https", ReplaceKeyWith: "replaceKey", HttpRedirectCode: 301 } }, ] }; // 设置桶的Website配置 const result = await obsClient.setBucketWebsite(params); if (result.CommonMsg.Status < 300) { hilog.info(0x0001, 'OBS-Harmony', "Set bucket(%s)'s website configuration successful!", params.Bucket); hilog.info(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId); return; } hilog.error(0x0001, 'OBS-Harmony', "An ObsError was found, which means your request sent to OBS was rejected with an error response."); hilog.error(0x0001, 'OBS-Harmony', "Status: %d", result.CommonMsg.Status); hilog.error(0x0001, 'OBS-Harmony', "Code: %s", result.CommonMsg.Code); hilog.error(0x0001, 'OBS-Harmony', "Message: %s", result.CommonMsg.Message); hilog.error(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId); } catch (error) { const err = error as BusinessError; hilog.error(0x0001, 'OBS-Harmony', 'An Exception occurred: code=%d, message: %s', err.code, err.message); } } setBucketWebsite(); ``` #### 相关链接 - 关于设置桶的网站配置的API说明，请参见[设置桶的网站配置](https://support.huaweicloud.com/api-obs/obs_04_0071.html)。 - 设置桶的Website配置过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 - 静态网站托管相关常见问题请参见[静态网站托管相关常见问题](https://support.huaweicloud.com/obs_faq/obs_faq_0500.html)。