OSS SDK for Node.jsを使用してバケットの保持ポリシーを設定することで、ユーザーが特定の期間内にバケット内のデータを変更または削除できないようにする - Object Storage Service

Object Storage Service (OSS) の保持ポリシーのWORM (Write Once Read Many) 機能を使用すると、ユーザーによるデータの変更や削除を防ぐことができます。リソース所有者を含め、特定の期間内にバケット内のオブジェクトを変更または削除したくない場合は、バケットの保持ポリシーを設定できます。保持ポリシーを設定すると、保持期間が終了するまで、ユーザーはバケット内のオブジェクトを読み取るか、バケットにオブジェクトをアップロードすることしかできません。ユーザーは、保持期間が終了した後にのみ、バケット内のオブジェクトを変更または削除できます。

説明

保持ポリシーを設定する前に、この機能に精通していることを確認してください。詳細については、「保持ポリシー」をご参照ください。

保持ポリシーの作成

次のサンプルコードは、保持ポリシーを作成する方法の例を示しています。

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

const client = new OSS({
  // Specify the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the region to oss-cn-hangzhou. 
  region: 'yourregion',
  // Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
  accessKeyId: process.env.OSS_ACCESS_KEY_ID,
  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,  
  authorizationV4: true,
  // Specify the name of your bucket.
  bucket: 'yourBucketName',
});
// Create a retention policy. 
async function initiateBucketWorm() {
 // Specify the name of the bucket. 
  const bucket = 'yourbucketname'
  // Specify the retention period of the retention policy. 
  const days = '<Retention Days>'
    const res = await client.initiateBucketWorm(bucket, days)
  console.log(res.wormId)
}

initiateBucketWorm()

ロック解除された保持ポリシーのキャンセル

次のサンプルコードでは、ロック解除された保持ポリシーをキャンセルする方法の例を示します。

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

const client = new OSS({
  // Specify the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the region to oss-cn-hangzhou. 
  region: 'yourregion',
  // Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
  accessKeyId: process.env.OSS_ACCESS_KEY_ID,
  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,  
  authorizationV4: true,
  // Specify the name of your bucket.
  bucket: 'yourBucketName',
});
// Cancel the retention policy. 
async function abortBucketWorm() {
  // Specify the name of the bucket. 
  const bucket = 'yourbucketname'
    try {
    await client.abortBucketWorm(bucket)
    console.log('abort success')
  } catch(err) {
        console.log('err: ', err)
    }
}

abortBucketWorm()

保持ポリシーのロック

次のサンプルコードは、保持ポリシーをロックする方法の例を示しています。

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

const client = new OSS({
  // Specify the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the region to oss-cn-hangzhou. 
  region: 'yourregion',
  // Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
  accessKeyId: process.env.OSS_ACCESS_KEY_ID,
  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
  authorizationV4: true,
  // Specify the name of your bucket.
  bucket: 'yourBucketName',
});
// Lock the retention policy. 
async function completeBucketWorm() {
  // Specify the name of the bucket. 
  const bucket = 'yourbucketname'
  const wormId = 'Your Worm Id'
    try {
        await client.completeBucketWorm(bucket, wormId)
  } catch(err) {
      console.log(err)
  }
}

completeBucketWorm()

クエリ保持ポリシー

次のサンプルコードは、バケットの保持ポリシーを照会する方法の例を示しています。

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

const client = new OSS({
  // Specify the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the region to oss-cn-hangzhou. 
  region: 'yourregion',
  // Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
  accessKeyId: process.env.OSS_ACCESS_KEY_ID,
  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
  authorizationV4: true,
  // Specify the name of your bucket.
  bucket: 'yourBucketName',
});
// Query the retention policies. 
async function getBucketWorm() {
  // Specify the name of the bucket. 
  const bucket = 'yourbucketname'
    try {
        const res = await client.getBucketWorm(bucket)
    // Query the IDs of the retention policies. 
    console.log(res.wormId)
    // Query the status of the retention policies. InProgress indicates that the retention policy is not locked. Locked indicates that the retention policy is locked. 
    console.log(res.state)
    // Query the retention period of the retention policies. 
    console.log(res.days)
  } catch(err) {
      console.log(err)
  }
}

getBucketWorm()

保持ポリシーの保持期間を延長する

次のサンプルコードは、ロックされた保持ポリシーの保持期間を延長する方法の例を示しています。

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

const client = new OSS({
  // Specify the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, firm the region to oss-cn-hangzhou. 
  region: 'yourregion',
  // Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
  accessKeyId: process.env.OSS_ACCESS_KEY_ID,
  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
  authorizationV4: true,
  // Specify the name of your bucket.
  bucket: 'yourBucketName',
});
// Extend the retention period of the locked retention policy. 
async function extendBucketWorm() {
  // Specify the name of the bucket. 
  const bucket = 'yourbucketname'
  const wormId = 'Your Worm Id'
  const days = 'Retention Days'
    try {
        const res = await client.extendBucketWorm(bucket, wormId, days)
    console.log(res)
  } catch(err) {
      console.log(err)
  }
}

extendBucketWorm()

Object Storage Service:OSS SDK for Node.jsを使用して保持ポリシーを設定する

保持ポリシーの作成

ロック解除された保持ポリシーのキャンセル

保持ポリシーのロック

クエリ保持ポリシー

保持ポリシーの保持期間を延長する

関連ドキュメント