设置桶清单规则(Node.js SDK)

功能介绍

桶清单功能可以定期生成桶内对象的相关信息，保存在CSV格式的文件中，并上传到您指定的桶中，方便您管理桶内对象。目标桶和源桶可以是同一个桶。指定的对象内容包括对象版本、大小、上次修改时间、存储类别、标签、加密状态等。

支持对桶清单加密，加密方式为SSE-KMS方式。

接口约束

• 您必须是桶拥有者或者拥有设置桶清单权限，才能设置桶清单。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketInventoryConfiguration权限，如果使用桶策略则需授予PutBucketInventoryConfiguration权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
• OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。
• 桶版本限制：
  • 只有OBS 3.0的桶支持配置清单，目标桶无OBS版本限制。
• 清单数量限制：
  • 一个桶最多支持10条桶清单。
• 源桶和目标桶限制：
  • 桶清单配置的源桶和目标桶必须归属同一个账号。
  • 桶清单配置的源桶和目标桶必须归属同一个区域。
  • 桶清单中配置的目标桶不能开启桶默认加密。
• 功能限制：
  • 只支持生成CSV格式的清单文件。
  • 桶清单筛选条件目前仅支持设置为所有对象或指定前缀的对象。
  • 同一个桶中多条清单规则的筛选条件不能彼此包含：
    • 如果已经存在针对桶中所有对象的规则，则无法再创建按对象名前缀筛选的规则。如需创建，要先删除针对所有对象的规则。
    • 如果已经存在按对象名前缀筛选的规则，则无法再创建针对桶中所有对象的规则。如需创建，要先删除所有按对象名前缀筛选的规则。
    • 如果已经存在某个按对象名前缀筛选的规则（如前缀ab），则无法再创建与其存在包含或被包含关系的规则（如前缀a或前缀abc）。如需创建，要先删除存在包含或被包含关系的规则。
  • 桶清单加密方式目前只支持SSE-KMS。
• 权限限制：
  • OBS系统用户会将清单文件上传到目标桶，所以目标桶必须给OBS系统用户写权限。
• 其他：
  • 暂不对桶清单功能收费，桶清单生成后只按照存量计费。

方法定义

ObsClient.setBucketInventory(params)

请求参数说明

返回结果

代码示例：设置桶清单规则

您可以通过ObsClient.setBucketInventory设置桶清单。代码示例如下：

// 引入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 setBucketInventory() {
  try {
    const params = {
      // 指定存储桶名称
      Bucket: "examplebucket",
      // 指定清单规则ID（URL参数）
      InventoryId: "inventory-config-001",
      // 指定清单规则ID（XML body字段，与InventoryId保持一致）
      Id: "inventory-config-001",
      // 指定是否启用
      IsEnabled: true,
      // 指定过滤配置
      Filter: {
        Prefix: "logs/"
      },
      // 指定目标配置
      Destination: {
        Format: "CSV",
        Bucket: "destination-bucketname",
        Prefix: "inventory-reports/"
      },
      // 指定导出周期
      Schedule: {
        Frequency: "Daily"
      },
      // 指定包含的版本
      IncludedObjectVersions: "Current",
      // 指定可选字段
      OptionalFields: {
        Field: ["Size", "LastModifiedDate", "StorageClass"]
      }
    };
    // 设置桶清单
    const result = await obsClient.setBucketInventory(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Set bucket inventory 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);
  };
};

setBucketInventory();