# 设置桶级默认WORM策略(Node.js SDK) #### 功能介绍 本接口用于为指定桶配置默认保护策略和保护期限。 当您在桶内配置了桶级默认WORM策略以后，如果您在上传对象时没有指定保护策略和保护期限，则新上传的对象会自动应用桶级默认WORM策略。和配置对象级WORM保护策略不同的地方在于，对象级WORM保护策略需要您提供一个明确的时间，在这个时间之前对象都会受到保护，桶级默认WORM策略则要求您提供一个保护期限，实际上对象受到保护的时间点为其上传时间+您指定的保护期限。 ![](https://support.huaweicloud.com/sdk-nodejs-devg-obs/public_sys-resources/note_3.0-zh-cn.png) - 您可以修改甚至清空桶级默认WORM策略，但这仅对修改后上传的对象生效，修改前上传的对象的保护状态不受影响。 - 多段上传的对象在合并前不受保护，合并后受桶级默认WORM策略保护，您可以在其合并后单独为其配置对象级WORM保护策略。 #### 接口约束 - 您必须是桶拥有者或者拥有配置桶级默认WORM策略权限，才能调用本接口。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketObjectLockConfiguration权限，如果使用桶策略则需授予PutBucketObjectLockConfiguration权限。相关授权方式介绍可参见[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)。 - 策略目前仅支持设置为合规模式"COMPLIANCE"。 - 支持设置的保留期限为1天-100\*365天或1年\~100年。 - OBS支持的region以及region与endPoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 ObsClient.setObjectLockConfiguration(params) #### 请求参数说明 表1请求参数列表 | 参数名称 | 参数类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | Bucket | string | 必选 | **参数解释：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **取值范围：** 长度为3～63个字符。 **默认取值：** 无 | | ObjectLockEnabled | string | 可选 | **参数解释：** 桶级WORM开关状态。 **约束限制：** 不涉及 **取值范围：** Enabled：启用桶级WORM功能。 **默认取值：** 不涉及 | | Rule | object | 可选 | **参数解释：** 默认保留规则配置，详见[表2 Rule]。 | 表2Rule | 参数名称 | 参数类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | DefaultRetention | object | 可选 | **参数解释：** 默认保留配置，详见[表3 DefaultRetention]。 | 表3DefaultRetention | 参数名称 | 参数类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | Mode | string | 必选 | **参数解释：** 桶的WORM保护策略。 **约束限制：** 不涉及 **取值范围：** COMPLIANCE：合规模式。 **默认取值：** COMPLIANCE | | Days | number | 和Years二选一，必须选择其中一个且不能同时指定 | **参数解释：** 保护天数。单位：天。 **约束限制：** 和Years二选一，必须选择其中一个且不能同时指定。 **取值范围：** 1\~36500 **默认取值：** 不涉及 | | Years | number | 和Days二选一，必须选择其中一个且不能同时指定 | **参数解释：** 默认的保护年数，单位：年。 **约束限制：** - 一年实际上视为保护365天，不考虑闰年。 - 和Days二选一，必须选择其中一个且不能同时指定。 **取值范围：** 1\~100 **默认取值：** 不涉及 | #### 返回结果 表4返回结果 | **参数类型** | 描述 | |:---|:---| | [表7](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_4001.html#obs_29_4001__table1722625714202) 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[表7](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_4001.html#obs_29_4001__table1722625714202)。 | 表5Response | **参数名称** | **参数类型** | 描述 | |:---|:---|:---| | CommonMsg | [ICommonMsg] | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见[ICommonMsg]。 | | InterfaceResult | [表7] | **参数解释：** 操作成功后的结果数据，详见[表7]。 **约束限制：** 当Status大于300时为空。 | 表6ICommonMsg | **参数名称** | **参数类型** | **描述** | |---|---|---| | 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服务端返回的详细错误码。 | 表7BaseResponseOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | #### 代码示例 您可以通过ObsClient.setObjectLockConfiguration设置桶级默认WORM策略。代码示例如下： ``` // 引入obs库 // 使用npm安装 const ObsClient = require("esdk-obs-nodejs"); // 使用源码安装 // var ObsClient = require('./lib/obs'); // 创建ObsClient实例 const obsClient = new ObsClient({ // 推荐通过环境变量获取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", }); async function setObjectLockConfiguration() { try { const params = { // 指定存储桶名称 Bucket: "examplebucket", // 指定对象锁定启用状态 ObjectLockEnabled: "Enabled", // 指定默认保留规则 Rule: { DefaultRetention: { Mode: "COMPLIANCE", Days: 30 } } }; // 配置桶级默认WORM策略 const result = await obsClient.setObjectLockConfiguration(params); if (result.CommonMsg.Status <= 300) { console.log("Set object lock configuration successful!\n"); 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); }; }; setObjectLockConfiguration(); ```