# 获取桶级默认WORM策略(Node.js SDK)
#### 功能介绍
获取指定桶设置的桶级默认WORM策略。
![](https://support.huaweicloud.com/sdk-nodejs-devg-obs/public_sys-resources/note_3.0-zh-cn.png)
如果您打开了桶级WORM开关，但从未配置过桶级默认WORM策略，您依然可以使用此接口查看开关的打开情况。
#### 接口约束
- 您必须是桶拥有者或者拥有获取桶级默认WORM策略权限，才能调用本接口。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketObjectLockConfiguration权限，如果使用桶策略则需授予GetBucketObjectLockConfiguration权限。相关授权方式介绍可参见[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以及region与endPoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。
 
#### 方法定义
ObsClient.getObjectLockConfiguration(params)
#### 请求参数说明
表1BucketRequestInput 
| **参数名称** | **参数类型** | **是否必选** | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| Bucket   | string   | 必选       | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。  - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。  - 禁止使用IP地址。  - 禁止以"-"或"."开头及结尾。  - 禁止两个"."相邻（如："my..bucket"）。  - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。    - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。   **取值范围：** 长度为3～63个字符。 **默认取值：** 无 |
   
表2返回结果 
| **参数类型**                                                                                                                                                | **描述**                                                                                  |
|:---|:---|
| [表3] 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[表3]。 |
   
 表3Response 
| **参数名称**        | **参数类型**                                       | **描述**                                                                                                                   |
|:---|:---|:---|
| CommonMsg       | [ICommonMsg] | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见[ICommonMsg]。 |
| InterfaceResult | [表5]        | **参数解释：** 操作成功后的结果数据，详见[表5]。                          |
   
 表4ICommonMsg 
| **参数名称**  | **参数类型** |                                                                                                                                                                                                       **描述**                                                                                                                                                                                                        |
|---|---|---|
| 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服务端返回的详细错误码。                                                                                                                                                                                                                                                                                                                                |
   
 表5InterfaceResult 
| 参数名称              | 参数类型   | 描述                                                                                                                               |
|:---|:---|:---|
| RequestId         | string | **参数解释：** OBS服务端返回的请求ID。                                                                           |
| ObjectLockEnabled | string | **参数解释：** 对象锁定启用状态。 **取值范围：** Enabled。 |
| Rule              | object | **参数解释：** 默认保留规则配置，详见[表6 Rule]。                                   |
   
 表6Rule 
| 参数名称             | 参数类型   | 描述                                                                                                       |
|:---|:---|:---|
| DefaultRetention | object | **参数解释：** 默认保留配置，详见[表7 DefaultRetention]。 |
   
 表7DefaultRetention 
| 参数名称  | 参数类型   | 描述                                                                                                                                     |
|:---|:---|:---|
| Mode  | string | **参数解释：** 保留模式。 **取值范围：** COMPLIANCE：合规模式。 |
| Days  | number | **参数解释：** 默认保留天数。                                                                                        |
| Years | number | **参数解释：** 默认保留年数。                                                                                         |
   
#### 代码示例
您可以通过ObsClient.getObjectLockConfiguration获取桶级默认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 getObjectLockConfiguration() {
  try {
    const params = {
      // 指定存储桶名称
      Bucket: "examplebucket",
    };
    // 获取桶级默认WORM策略
    const result = await obsClient.getObjectLockConfiguration(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Get object lock configuration successful!");
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      if (result.InterfaceResult) {
        console.log("ObjectLockEnabled: %s", result.InterfaceResult.ObjectLockEnabled);
        const rule = result.InterfaceResult.Rule;
        if (rule && rule.DefaultRetention) {
          console.log("Mode: %s", rule.DefaultRetention.Mode);
          console.log("Days: %s", rule.DefaultRetention.Days);
        }
      }
      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);
  };
};
getObjectLockConfiguration();
```