# 设置桶清单规则(Node.js SDK) #### 功能介绍 桶清单功能可以定期生成桶内对象的相关信息，保存在CSV格式的文件中，并上传到您指定的桶中，方便您管理桶内对象。目标桶和源桶可以是同一个桶。指定的对象内容包括对象版本、大小、上次修改时间、存储类别、标签、加密状态等。 支持对桶清单加密，加密方式为SSE-KMS方式。 #### 接口约束 - 您必须是桶拥有者或者拥有设置桶清单权限，才能设置桶清单。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketInventoryConfiguration权限，如果使用桶策略则需授予PutBucketInventoryConfiguration权限。相关授权方式介绍可参见[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)。 - **桶版本限制：** - 只有OBS 3.0的桶支持配置清单，目标桶无OBS版本限制。 - **清单数量限制：** - 一个桶最多支持10条桶清单。 - **源桶和目标桶限制：** - 桶清单配置的源桶和目标桶必须归属同一个账号。 - 桶清单配置的源桶和目标桶必须归属同一个区域。 - 桶清单中配置的目标桶不能开启桶默认加密。 - **功能限制：** - 只支持生成CSV格式的清单文件。 - 桶清单筛选条件目前仅支持设置为所有对象或指定前缀的对象。 - 同一个桶中多条清单规则的筛选条件不能彼此包含： - 如果已经存在针对桶中所有对象的规则，则无法再创建按对象名前缀筛选的规则。如需创建，要先删除针对所有对象的规则。 - 如果已经存在按对象名前缀筛选的规则，则无法再创建针对桶中所有对象的规则。如需创建，要先删除所有按对象名前缀筛选的规则。 - 如果已经存在某个按对象名前缀筛选的规则（如前缀ab），则无法再创建与其存在包含或被包含关系的规则（如前缀a或前缀abc）。如需创建，要先删除存在包含或被包含关系的规则。 - 桶清单加密方式目前只支持SSE-KMS。 - **权限限制：** - OBS系统用户会将清单文件上传到目标桶，所以目标桶必须给OBS系统用户写权限。 - **其他：** - 暂不对桶清单功能收费，桶清单生成后只按照存量计费。 #### 方法定义 ObsClient.setBucketInventory(params) #### 请求参数说明 表1请求参数列表 | 参数名称 | 参数类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | Bucket | string | 必选 | **参数解释：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **取值范围：** 长度为3～63个字符。 **默认取值：** 无 | | InventoryId | string | 必选 | **参数解释：** 清单规则ID。 **约束限制：** 用于唯一标识一条清单规则。 **默认取值：** 无 | | Id | string | 可选 | **参数解释：** 清单规则ID。 **约束限制：** 用于唯一标识一条清单规则，与InventoryId保持一致。 **默认取值：** 无 | | IsEnabled | boolean | 必选 | **参数解释：** 是否启用该清单规则。 **取值范围：** true：启用该清单规则。 false：禁用该清单规则。 **默认取值：** 无 | | Filter | object | 可选 | **参数解释：** 清单过滤配置，详见[表2]。 | | Destination | object | 必选 | **参数解释：** 清单文件导出目标配置，详见[表3 Destination]。 | | Schedule | object | 必选 | **参数解释：** 清单导出周期配置，详见[表4 Schedule]。 | | IncludedObjectVersions | string | 必选 | **参数解释：** 是否包含对象的所有版本。 **取值范围：** - All：包含所有版本 - Current：仅当前版本 默认取值： 无 | | OptionalFields | object | 可选 | **参数解释：** 清单中包含的可选字段配置，详见[表5 OptionalFields]。 | 表2Filter | 参数名称 | 参数类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | Prefix | string | 可选 | **参数解释**： 对象名前缀。 **约束限制：** 仅匹配该前缀的对象会被列入清单。 **默认取值：** 无 | 表3Destination | 参数名称 | 参数类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | Format | string | 必选 | **参数解释：** 清单文件格式。 **取值范围：** CSV。 **默认取值：** 无 | | Bucket | string | 必选 | **参数解释：** 清单文件导出的目标桶名。 **默认取值：** 无 | | Prefix | string | 可选 | **参数解释：** 清单文件在目标桶中的存储路径前缀。 **默认取值：** 无 | 表4Schedule | 参数名称 | 参数类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | Frequency | string | 必选 | **参数解释：** 清单导出周期。 **取值范围：** Daily（每天）、Weekly（每周）。 **默认取值：** 无 | 表5OptionalFields | 参数名称 | 参数类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | Field | array | 可选 | **参数解释：** 可选字段列表。 **取值范围：** Size：对象大小。 LastModifiedDate：对象最后修改时间。 StorageClass：对象的存储类别。 ETag：对象的ETag值。 IsMultipartUploaded：对象是否为[多段上传](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1901.html)。 ReplicationStatus：对象的跨区域复制状态。 EncryptionStatus：对象的加密状态。 **默认取值：** 无 | #### 返回结果 表6返回结果 | **参数类型** | 描述 | |:---|:---| | [表7] 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[表7]。 | 表7Response | **参数名称** | **参数类型** | 描述 | |:---|:---|:---| | CommonMsg | [ICommonMsg](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_0308.html#obs_29_0308__table99101047323) | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见[ICommonMsg](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_0308.html#obs_29_0308__table99101047323)。 | | InterfaceResult | [表5](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_0308.html#obs_29_0308__table33959011) | **参数解释：** 操作成功后的结果数据，详见[表5](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_0308.html#obs_29_0308__table33959011)。 **约束限制：** 当Status大于300时为空。 | 表8ICommonMsg | **参数名称** | **参数类型** | **描述** | |---|---|---| | 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服务端返回的详细错误码。 | 表9BaseResponseOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | #### 代码示例：设置桶清单规则 您可以通过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(); ```