Object Storage Service:Bucket inventory (OSS SDK for Node.js)

Prerequisites

Before you begin, make sure that you have:

• The ali-oss SDK installed

• The OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables configured

• An existing source bucket (the bucket to inventory)

• An existing destination bucket in the same region as the source bucket

Client initialization

All examples below use the following client initialization. Replace the placeholder values with your actual bucket name and region.

const OSS = require('ali-oss');

const client = new OSS({
  bucket: 'yourBucketName',
  // Example: 'oss-cn-hangzhou'
  region: 'yourRegion',
  accessKeyId: process.env.OSS_ACCESS_KEY_ID,
  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
  authorizationV4: true,
});

Inventory configuration parameters

The following table describes the inventory configuration parameters.

Usage notes

• A bucket supports a maximum of 1,000 inventory rules.

• The source bucket and the destination bucket must be in the same region.

Add an inventory configuration

const inventory = {
  id: 'default',
  isEnabled: false,
  // Filter objects by prefix
  prefix: 'ttt',
  OSSBucketDestination: {
    format: 'CSV',
    accountId: 'yourAccountId',
    rolename: 'AliyunOSSRole',
    bucket: 'yourDestinationBucketName',
    prefix: 'yourPrefix',
    // To encrypt with SSE-OSS:
    // encryption: {'SSE-OSS': ''}

    // To encrypt with SSE-KMS:
    // encryption: {
    //   'SSE-KMS': {
    //     keyId: 'test-kms-id'
    //   }
    // }
  },
  frequency: 'Daily',
  includedObjectVersions: 'All',
  optionalFields: {
    field: [
      'Size',
      'LastModifiedDate',
      'ETag',
      'StorageClass',
      'IsMultipartUploaded',
      'EncryptionStatus',
    ],
  },
};

async function putInventory() {
  const bucket = 'yourBucketName';
  try {
    await client.putBucketInventory(bucket, inventory);
    console.log('Inventory configuration added.');
  } catch (err) {
    console.log('Failed to add inventory configuration:', err.code, err.message);
  }
}

putInventory();

View an inventory configuration

Pass the inventory configuration ID to getBucketInventory to retrieve a specific configuration.

async function getBucketInventoryById() {
  const bucket = 'yourBucketName';
  try {
    const result = await client.getBucketInventory(bucket, 'inventoryid');
    console.log(result.inventory);
  } catch (err) {
    console.log('Failed to get inventory configuration:', err.code, err.message);
  }
}

getBucketInventoryById();

List inventory configurations

A single request returns a maximum of 100 inventory configurations. To retrieve more, pass the nextContinuationToken from the previous response as the second argument.

async function listBucketInventory() {
  const bucket = 'yourBucketName';

  async function getNextPage(nextContinuationToken) {
    const result = await client.listBucketInventory(bucket, nextContinuationToken);
    console.log(result.inventoryList);

    if (result.nextContinuationToken) {
      await getNextPage(result.nextContinuationToken);
    }
  }

  await getNextPage();
}

listBucketInventory();

Delete an inventory configuration

Pass the inventory configuration ID to deleteBucketInventory to remove a specific configuration.

async function deleteBucketInventoryById() {
  const bucket = 'yourBucketName';
  const inventoryId = 'yourInventoryId';
  try {
    await client.deleteBucketInventory(bucket, inventoryId);
    console.log('Inventory configuration deleted.');
  } catch (err) {
    console.log('Failed to delete inventory configuration:', err.code, err.message);
  }
}

deleteBucketInventoryById();

Error handling

Common errors when managing inventory configurations:

References

• Complete sample code on GitHub

• PutBucketInventory

• GetBucketInventory

• ListBucketInventory

• DeleteBucketInventory