更新时间:2026-08-28 GMT+08:00
分享

获取桶清单规则(Node.js SDK)

功能介绍

您可以使用获取桶清单规则接口获取指定桶的清单规则,可以通过配置规则id来选择指定清单规则。

接口约束

  • 您必须是桶拥有者或者拥有获取桶清单权限,才能获取桶清单。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:GetInventoryConfiguration权限,如果使用桶策略则需授予GetInventoryConfiguration权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略自定义创建桶策略
  • OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点

方法定义

ObsClient.getBucketInventory(params)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

Bucket

string

必选

参数解释:

桶名。

约束限制:

  • 桶的名字需全局唯一,不能与已有的任何桶名称重复,包括其他用户创建的桶。
  • 桶命名规则如下:
    • 3~63个字符,数字或字母开头,支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻(如:“my..bucket”)。
    • 禁止“.”和“-”相邻(如:“my-.bucket”和“my.-bucket”)。
  • 同一用户在同一个区域多次创建同名桶不会报错,创建的桶属性以第一次请求为准。

取值范围:

长度为3~63个字符。

默认取值:

InventoryId

string

必选

参数解释:

清单规则ID。

默认取值:

返回结果

表2 返回结果

参数类型

描述

表3

说明:

该接口返回是一个Promise类型,需要使用Promise、async/await语法处理。

参数解释:

接口返回信息,详见表3

表3 Response

参数名称

参数类型

描述

CommonMsg

ICommonMsg

参数解释:

接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等,详见ICommonMsg

InterfaceResult

表5

参数解释:

操作成功后的结果数据,详见表5

表4 ICommonMsg

参数名称

参数类型

描述

Status

number

参数解释:

OBS服务端返回的HTTP状态码。

取值范围:

状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码

Code

string

参数解释:

OBS服务端返回的错误码。

Message

string

参数解释:

OBS服务端返回的错误描述。

HostId

string

参数解释:

OBS服务端返回的请求服务端ID。

RequestId

string

参数解释:

OBS服务端返回的请求ID。

Id2

string

参数解释:

OBS服务端返回的请求ID2。

Indicator

string

参数解释:

OBS服务端返回的详细错误码。

表5 InterfaceResult

参数名称

参数类型

描述

RequestId

string

参数解释:

OBS服务端返回的请求ID。

Id

string

参数解释:

清单规则ID。

IsEnabled

boolean

参数解释:

是否启用该清单规则。

Filter

object

参数解释:

清单过滤配置,详见表6 Filter

Destination

object

参数解释:

清单文件导出目标配置,详见表7 Destination

Schedule

object

参数解释:

清单导出周期配置,详见表8 Schedule

IncludedObjectVersions

string

参数解释:

是否包含对象的所有版本。

取值范围:

  • All:包含所有版本
  • Current:仅当前版本

OptionalFields

object

参数解释:

可选字段配置,详见表9 OptionalFields

表6 Filter

参数名称

参数类型

描述

Prefix

string

参数解释:

对象名前缀。

表7 Destination

参数名称

参数类型

描述

Format

string

参数解释:

清单文件格式。

Bucket

string

参数解释:

目标桶名。

Prefix

string

参数解释:

目标路径前缀。

表8 Schedule

参数名称

参数类型

描述

Frequency

string

参数解释:

清单导出周期。

取值范围:

  • Daily:每天。
  • Weekly:每周。
表9 OptionalFields

参数名称

参数类型

描述

Field

array

参数解释:

可选字段列表。

代码示例

您可以通过ObsClient.getBucketInventory获取桶清单。代码示例如下:

// 引入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 getBucketInventory() {
  try {
    const params = {
      // 指定存储桶名称
      Bucket: "examplebucket",
      // 指定清单规则ID
      InventoryId: "inventory-config-001",
    };
    // 获取桶清单
    const result = await obsClient.getBucketInventory(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Get bucket inventory successful!");
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      if (result.InterfaceResult) {
        console.log("Id: %s", result.InterfaceResult.Id);
        console.log("IsEnabled: %s", result.InterfaceResult.IsEnabled);
        console.log("Frequency: %s", result.InterfaceResult.Schedule.Frequency);
      }
      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);
  };
};

getBucketInventory();

相关文档