# 设置在线解压策略(Node.js SDK)
#### 功能介绍
OBS支持ZIP包上传后自动解压并存放在指定目录。桶设置了在线解压策略后，上传到该桶内的ZIP包如果匹配解压策略，ZIP包将会自动解压到指定目录里。本接口用于为指定桶配置ZIP文件解压策略。了解更多在线解压相关信息，请参见[在线解压](https://support.huaweicloud.com/usermanual-obs/obs_03_0368.html)。
融合桶不支持在线解压。
#### 接口约束
**权限限制：**
- 需要使用IAM的角色与策略授权功能，增加Tenant Administrator权限后才能设置、获取、删除在线解压策略。
- 在线解压源需使用IAM创建云服务委托，委托OBS获取桶内数据，上传数据到桶内。委托需要给OBS服务授予obs:object:PutObject、obs:object:GetObject、obs:object:AbortMultipartUpload权限。
**包及文件大小限制：**
- 单个ZIP包大小上限为**1GB**。
- 单个ZIP包内最多可包含65536个文件。
- ZIP包内，单个文件解压后最大为40GB。
**时间限制：**
- ZIP包解压任务最大时长为10分钟。
**功能限制：**
- ZIP包的后缀必须为zip。
- ZIP包名称中不可带有中文标点符号、特殊符号和特殊编码，如：\\/:\*?"\<\>\|@#￥。
- 针对ZIP包嵌套的场景，在线解压策略的事件类型需设置为ObjectCreated:\*或ObjectCreated:CompleteMultipartUpload。
- 目前不支持解压任务完成后给用户发送消息通知。
- 目前仅支持解压压缩算法为deflated的ZIP包，此处的压缩算法与WINRAR等软件提供的Store、Normal等压缩方法不等同。
- 解压路径加上压缩包解压出文件的文件名，总字符长度不可超过512，否则会导致解压失败。
- 目前不支持解压加密ZIP包。
- 不支持企业联邦用户使用在线解压功能，更多关于联邦用户的相关信息请参考[账号与用户的关系](https://support.huaweicloud.com/iam_faq/iam_01_0615.html)和[身份提供商概述](https://support.huaweicloud.com/usermanual-iam/iam_08_0001.html)。

- OBS支持的region以及region与endPoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。
 
#### 方法定义
ObsClient.setBucketCompressPolicy(params)
#### 请求参数说明
表1请求参数列表 
| 参数名称 | 参数类型  | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| Bucket    | string     | 必选       | **参数解释：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。  - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。  - 禁止使用IP地址。  - 禁止以"-"或"."开头及结尾。  - 禁止两个"."相邻（如："my..bucket"）。  - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。    - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。   **取值范围：** 长度为3～63个字符。 **默认取值：** 无 |
| Rules | string | 必选 | **参数解释：** 在线解压规则列表，JSON格式的字符串。 **约束限制：** - 同一个桶下的不同规则前缀不能重复或存在起始包含关系，委托建议使用同一个。  - 每个桶最多创建10条在线解压规则。   **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
   
表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服务端返回的详细错误码。                                                                                                                                                                                                                                                                                                                                                         |
   
 表5BaseResponseOutput 
| **参数名称** | **参数类型** | **描述**                                                                                                                             |
|:---|:---|:---|
| RequestId     | string     | **参数解释：** OBS服务端返回的请求ID。 |
   
#### 代码示例
您可以通过ObsClient.setBucketCompressPolicy设置在线解压策略。代码示例如下：
```
// 引入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 setBucketCompressPolicy() {
  try {
    // 构建在线解压规则（JSON字符串）
    const rules = JSON.stringify({
        rules: [{
            id: 'decompress-rule-001',
            project: 'your_projectId' ,
            agency: 'your_agency',
            events: ['ObjectCreated:*'],
            prefix: 'decompress/',
            suffix: '.zip',
            overwrite: 0,
            decompresspath: 'output/',
            policytype: 'decompress'
        }]
    });
    const params = {
      // 指定存储桶名称
      Bucket: "examplebucket",
      // 指定在线解压规则
      Rules: rules,
    };
    // 设置在线解压策略
    const result = await obsClient.setBucketCompressPolicy(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Set bucket compress policy 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);
  };
};
setBucketCompressPolicy();
```