# 获取桶的生命周期配置(Node.js SDK)
![](https://support.huaweicloud.com/sdk-nodejs-devg-obs/public_sys-resources/notice_3.0-zh-cn.png)
开发过程中，您有任何问题可以在GitHub上[提交issue](https://github.com/huaweicloud/huaweicloud-sdk-nodejs-obs/issues)，或者在[华为云对象存储服务论坛](https://bbs.huaweicloud.com/forum/forum-620-1.html)中发帖求助。
#### 功能介绍
OBS支持用户配置指定的规则，实现定时删除桶中的对象或者定时转换对象的存储类别，从而节省存储费用，更多生命周期相关信息请参见[生命周期管理](https://support.huaweicloud.com/usermanual-obs/obs_03_0335.html)。
调用获取桶的生命周期配置接口，您可以获取指定桶的生命周期策略。
#### 接口约束
- 您必须是桶拥有者或拥有获取桶的生命周期配置的权限，才能获取桶的生命周配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetLifecycleConfiguration权限，如果使用桶策略则需授予GetLifecycleConfiguration权限。相关授权方式介绍可参见[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)。
 
#### 方法定义
```
ObsClient.getBucketLifecycle(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]。 **约束限制** **：** 当Status大于300时为空。 |
   
 表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服务端返回的详细错误码。                                                                                                                                                                                                                                                                                                                                |
   
 表5GetBucketLifecycleOutput 
| **参数名称**  | **参数类型**                                               | **描述**                                                                                                                                                                                                |
|:---|:---|:---|
| RequestId | string                                                 | **参数解释：** OBS服务端返回的请求ID。 **默认取值：** 无 |
| Rules     | [LifecycleRule]\[\] | 必选 **参数解释：** 桶生命周期规则列表，详见[LifecycleRule]。                                                                |
   
 表6LifecycleRule 
| **参数名称**                     | **参数类型**                                                            | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|
| ID                           | string                                                              | **参数解释：** 生命周期规则ID。                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Prefix                       | string                                                              | **参数解释：** 对象名前缀，用以标识哪些对象可以匹配到当前这条规则。可为空字符串，代表匹配桶内所有对象。 例如，假设您拥有以下对象：logs/day1、logs/day2、logs/day3和ExampleObject.jpg。如果您将ExampleObject.jpg指定为前缀，则规则仅应用于该特定对象。如果您将logs/指定为前缀，规则将应用于密钥名称以字符串"logs/"开头的三个对象。如果您指定空的前缀，规则将应用于桶中的所有对象。                                                                                                                                                                               |
| Status                       | string                                                              | **参数解释：** 标识当前规则是否启用。 **取值范围：** Enabled：启用 Disabled：不启用。                                                                                                                                                                                                                                                                                            |
| Transitions                  | [Transition]\[\]                   | **参数解释：** 对象转换策略列表，用于使用生命周期规则转换对象的存储类别，包含生命周期配置的迁移时间和迁移后对象存储级别，详见[Transition]。 **约束限制：** 仅针对对象的最新版本。                                                                                                                                                                                                                                            |
| Expiration                   | [Expiration]                     | **参数解释：** 对象过期时间配置，详见[Expiration]。 **约束限制：** 仅针对对象的最新版本。                                                                                                                                                                                                                                                                                      |
| NoncurrentVersionTransitions | [NoncurrentVersionTransition]\[\] | **参数解释：** 历史版本对象转换策略列表，用于使用生命周期规则转换历史版本对象的存储类别，包含生命周期配置的迁移时间和迁移后对象存储级别，详见[NoncurrentVersionTransition]。 **约束限制：** - 仅针对对象的历史版本。  - 当前桶已启用（或开启后暂停）多版本。                                       |
| NoncurrentVersionExpiration  | [NoncurrentVersionExpiration]     | **参数解释：** 历史版本对象过期时间配置，详见[NoncurrentVersionExpiration]。 **约束限制：** - 仅针对对象的历史版本。  - 当前桶已启用（或开启后暂停）多版本。  - 并行文件系统不支持该参数。   |
   
 表7Transition 
| **参数名称**     | **参数类型**                                           | **描述**                                                           |
|:---|:---|:---|
| StorageClass | [StorageClassType] | **参数解释：** 对象转换后的存储类型。                |
| Date         | string                                             | **参数解释：** 指定OBS对该日期之前的对象执行生命周期规则。 |
| Days         | number                                             | **参数解释：** 指定生命周期规则在对象最后更新过后多少天生效。   |
   
 表8Expiration 
| **参数名称** | **参数类型** | **描述**                                                                                            |
|:---|:---|:---|
| Date     | string   | **参数解释：** 指定OBS对该日期之前的对象执行生命周期规则，即执行过期删除操作。 |
| Days     | number   | **参数解释：** 指定生命周期规则在对象最后更新过后多少天生效，即执行过期删除操作。   |
   
 表9NoncurrentVersionTransition 
| **参数名称**       | **参数类型**                                           | **描述**                                                        |
|:---|:---|:---|
| StorageClass   | [StorageClassType] | **参数解释：** 历史版本对象转换后的存储类型。      |
| NoncurrentDays | number                                             | **参数解释：** 表示对象在成为历史版本之后第几天时规则生效。 |
   
 表10NoncurrentVersionExpiration 
| **参数名称**       | **参数类型** | **描述**                                                                               |
|:---|:---|:---|
| NoncurrentDays | number   | **参数解释：** 表示对象在成为历史版本之后第几天时规则生效。 |
   
表11AbortIncompleteMultipartUpload 
| **参数名称**            | **参数类型** | **描述**                                                                                                       |
|:---|:---|:---|
| DaysAfterInitiation | number   | **参数解释：** 指定未合并的多段任务（碎片）的生命周期规则，在多段任务初始化过后多少天生效。 |
   
 表12StorageClassType 
| **常量名**                              | **原始值**      | **说明**                                                                                                                             |
|:---|:---|:---|
| ObsClient.enums.StorageClassStandard | STANDARD     | 标准存储。 标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（\<1MB），且需要频繁访问数据的业务场景。 |
| ObsClient.enums.StorageClassWarm     | WARM         | 低频访问存储。 低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。                |
| ObsClient.enums.StorageClassCold     | COLD         | 归档存储。 归档存储适用于很少访问（平均一年访问一次）数据的业务场景。                                     |
| 无                                    | DEEP_ARCHIVE | 深度归档存储 适用于长期不访问（平均几年访问一次）数据的业务场景                                         |
   
#### 代码示例
您可以通过ObsClient.getBucketLifecycle查看桶的生命周期规则。以下代码展示了如何获取名为examplebucket桶的生命周期规则。
```
// 引入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 getBucketLifecycle() {
  try {
    const params = {
      // 指定存储桶名称
      Bucket: "examplebucket"
    };
    // 获取桶的生命周期规则
    const result = await obsClient.getBucketLifecycle(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Get bucket(%s)'s lifecycle configuration successful!", params.Bucket);
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      for (let i = 0; i < result.InterfaceResult.Rules.length; i++) {
        const rule = result.InterfaceResult.Rules[i];
        console.log("ID:%s, Prefix:%s, Status:%s, Expiration[Date]:%s, Expiration[Days]:%d, NoncurrentVersionExpiration[NoncurrentDays]:%s",
          rule.ID, rule.Prefix, rule.Status, rule.Expiration.Date,
          rule.Expiration.Days, rule.NoncurrentVersionExpiration.NoncurrentDays
        );
      };
      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);
  };
};
getBucketLifecycle();
```