获取桶清单规则(Node.js SDK)
功能介绍
您可以使用获取桶清单规则接口获取指定桶的清单规则,可以通过配置规则id来选择指定清单规则。
接口约束
- 您必须是桶拥有者或者拥有获取桶清单权限,才能获取桶清单。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:GetInventoryConfiguration权限,如果使用桶策略则需授予GetInventoryConfiguration权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
- OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点。
方法定义
ObsClient.getBucketInventory(params)
请求参数说明
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| Bucket | string | 必选 | 参数解释: 桶名。 约束限制:
取值范围: 长度为3~63个字符。 默认取值: 无 |
| InventoryId | string | 必选 | 参数解释: 清单规则ID。 默认取值: 无 |
返回结果
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| CommonMsg | 参数解释: 接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等,详见ICommonMsg。 | |
| InterfaceResult | 参数解释: 操作成功后的结果数据,详见表5。 |
| 参数名称 | 参数类型 | 描述 |
| 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服务端返回的详细错误码。 |
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| RequestId | string | 参数解释: OBS服务端返回的请求ID。 |
| Id | string | 参数解释: 清单规则ID。 |
| IsEnabled | boolean | 参数解释: 是否启用该清单规则。 |
| Filter | object | 参数解释: 清单过滤配置,详见表6 Filter。 |
| Destination | object | 参数解释: 清单文件导出目标配置,详见表7 Destination。 |
| Schedule | object | 参数解释: 清单导出周期配置,详见表8 Schedule。 |
| IncludedObjectVersions | string | 参数解释: 是否包含对象的所有版本。 取值范围:
|
| OptionalFields | object | 参数解释: 可选字段配置,详见表9 OptionalFields。 |
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| Prefix | string | 参数解释: 对象名前缀。 |
代码示例
您可以通过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();