获取桶存量信息(Harmony SDK)

功能介绍

调用获取桶存量信息接口，可查询指定桶内的对象个数，以及对象占用空间的大小。

由于OBS桶存量是后台统计，因此存量会有一定的时延，不能实时更新，因此不建议对存量做实时校验。

接口约束

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

方法定义

getBucketStorageInfo(input: BucketRequestInput): Response<GetBucketStorageInfoOutput>

请求参数

返回结果

代码示例

本示例用于获取名为examplebucket桶的存量信息，包括桶对象个数及对象占用空间。

// 引入依赖包
import ObsClient, { BucketRequestInput } from '@obs/esdk-obs-harmony';

// 创建ObsClient实例
const obsClient = new ObsClient({
  // 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
  // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
  AccessKeyId: process.env.ACCESS_KEY_ID,
  SecretAccessKey: process.env.SECRET_ACCESS_KEY,
  // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入
  // SecurityToken: process.env.SECURITY_TOKEN,
  // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写
  Server: "https://obs.cn-north-4.myhuaweicloud.com",
});

async function getBucketStorageInfo() {
  try {
    const params: BucketRequestInput = {
      // 指定存储桶名称
      Bucket: "examplebucket"
    };
    // 获取桶存量信息
    const result = await obsClient.getBucketStorageInfo(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Get bucket(%s)'s storage-info successful!", params.Bucket);
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      console.log('Size: %s', result.InterfaceResult.Size);
      console.log('Objectnumber: %s', result.InterfaceResult.Objectnumber);
      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);
  }
}

getBucketStorageInfo();

相关链接

• 关于获取桶存量信息的API说明，请参见获取桶存量信息。
• 获取桶存量信息过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
• 桶和对象相关常见问题请参见桶和对象相关常见问题。