Object Storage Service：Kebijakan retensi (WORM)

Skenario

Fitur WORM yang disediakan oleh kebijakan retensi di OSS membantu perusahaan memenuhi persyaratan regulasi dan kepatuhan dari U.S. Securities and Exchange Commission (SEC) dan Financial Industry Regulatory Authority (FINRA). Fitur ini cocok untuk sektor-sektor seperti keuangan, asuransi, kesehatan, dan sekuritas, serta untuk skenario seperti audit data log dalam Multi-Layer Protection Scheme (MLPS).

Prasyarat

Pastikan versioning diaktifkan atau dinonaktifkan untuk bucket tempat Anda ingin menetapkan kebijakan retensi. Anda tidak dapat menetapkan kebijakan retensi jika versioning ditangguhkan. Untuk informasi selengkapnya tentang versioning, lihat Versioning.

Catatan

• Anda hanya dapat mengonfigurasi kebijakan retensi untuk bucket.

• Anda tidak dapat mengaktifkan OSS-HDFS dan mengonfigurasi kebijakan retensi untuk bucket yang sama.

• Selama periode retensi, Anda dapat mengonfigurasi aturan lifecycle untuk mengubah kelas penyimpanan objek dalam bucket guna mengurangi biaya penyimpanan dan memastikan kepatuhan.

Deskripsi aturan

• Aturan Aktif

  Secara default, kebijakan retensi berbasis waktu berada dalam status InProgress selama 24 jam setelah dibuat. Selama periode ini, resource bucket dilindungi.

  • Dalam 24 jam setelah kebijakan retensi dibuat

    • Jika kebijakan retensi belum dikunci, pemilik bucket dan pengguna yang berwenang dapat menghapus kebijakan tersebut.

    • Jika kebijakan retensi telah dikunci, kebijakan tersebut tidak dapat dihapus dan periode retensinya tidak dapat dipersingkat. Namun, periode retensi dapat diperpanjang. Data dalam bucket dilindungi oleh kebijakan retensi. Jika Anda mencoba menghapus atau memodifikasi data dalam bucket, error 409 FileImmutable akan dikembalikan.

  • Lebih dari 24 jam setelah kebijakan retensi dibuat

    Jika kebijakan retensi belum dikunci lebih dari 24 jam setelah dibuat, kebijakan tersebut menjadi tidak valid dan dapat dihapus.

• Penghapusan

  • Kebijakan retensi berbasis waktu merupakan atribut metadata dari sebuah bucket. Jika bucket dihapus, kebijakan retensi bucket tersebut juga dihapus.

  • Jika kebijakan retensi belum dikunci dalam 24 jam setelah dibuat, pemilik bucket dan pengguna yang berwenang dapat menghapus kebijakan tersebut.

  • Jika bucket berisi objek yang dilindungi oleh kebijakan retensi, Anda tidak dapat menghapus bucket atau kebijakan retensi tersebut.

• Contoh

  Misalnya, Anda membuat kebijakan retensi dengan periode retensi 30 hari untuk sebuah bucket pada 1 Juni 2022, dan segera mengunci kebijakan tersebut. Anda mengunggah tiga objek, file1.txt, file2.txt, dan file3.txt, pada waktu yang berbeda. Tabel berikut mencantumkan tanggal unggah dan tanggal kedaluwarsa objek-objek tersebut.

  Nama objek	Tanggal unggah	Tanggal kedaluwarsa objek
  file1.txt	1 April 2022	30 April 2022
  file2.txt	1 Juni 2022	30 Juni 2022
  file3.txt	1 September 2022	30 September 2022

Metode

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.InitiateBucketWormRequest;
import com.aliyun.oss.model.InitiateBucketWormResult;

public class Demo {

    public static void main(String[] args) throws Exception {
        // Dalam contoh ini, endpoint wilayah China (Hangzhou) digunakan. Tentukan endpoint aktual Anda. 
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // Dapatkan kredensial akses dari variabel lingkungan. Sebelum menjalankan kode contoh, pastikan variabel lingkungan OSS_ACCESS_KEY_ID dan OSS_ACCESS_KEY_SECRET telah dikonfigurasi. 
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // Tentukan nama bucket. Contoh: examplebucket. 
        String bucketName = "examplebucket";
        // Tentukan wilayah tempat bucket berada. Misalnya, jika bucket berada di wilayah China (Hangzhou), atur wilayah ke cn-hangzhou. 
        String region = "cn-hangzhou";

        // Buat instance OSSClient. 
        // Panggil metode shutdown untuk melepaskan resource saat OSSClient tidak lagi digunakan.
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);        
        OSS ossClient = OSSClientBuilder.create()
        .endpoint(endpoint)
        .credentialsProvider(credentialsProvider)
        .clientConfiguration(clientBuilderConfiguration)
        .region(region)               
        .build();

        try {
            // Buat objek InitiateBucketWormRequest. 
            InitiateBucketWormRequest initiateBucketWormRequest = new InitiateBucketWormRequest(bucketName);
            // Atur periode retensi menjadi 1 hari. 
            initiateBucketWormRequest.setRetentionPeriodInDays(1);

            // Buat kebijakan retensi. 
            InitiateBucketWormResult initiateBucketWormResult = ossClient.initiateBucketWorm(initiateBucketWormRequest);

            // Tampilkan ID kebijakan retensi. 
            String wormId = initiateBucketWormResult.getWormId();
            System.out.println(wormId);
        } catch (OSSException oe) {
            System.out.println("Caught an OSSException, which means your request made it to OSS, "
                    + "but was rejected with an error response for some reason.");
            System.out.println("Error Message:" + oe.getErrorMessage());
            System.out.println("Error Code:" + oe.getErrorCode());
            System.out.println("Request ID:" + oe.getRequestId());
            System.out.println("Host ID:" + oe.getHostId());
        } catch (ClientException ce) {
            System.out.println("Caught an ClientException, which means the client encountered "
                    + "a serious internal problem while trying to communicate with OSS, "
                    + "such as not being able to access the network.");
            System.out.println("Error Message:" + ce.getMessage());
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
            }
        }
    }
}

<?php

// Masukkan file autoload untuk memuat library dependensi.
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// Tentukan deskripsi untuk parameter baris perintah.
$optsdesc = [
    "region" => ['help' => 'Wilayah tempat bucket berada.', 'required' => True], // (Wajib) Tentukan wilayah tempat bucket berada.
    "endpoint" => ['help' => 'Nama domain yang dapat digunakan layanan lain untuk mengakses OSS', 'required' => False], // (Opsional) Tentukan endpoint yang dapat digunakan layanan lain untuk mengakses OSS.
    "bucket" => ['help' => 'Nama bucket', 'required' => True], // (Wajib) Tentukan nama bucket.
];

// Hasilkan daftar opsi panjang untuk mengurai parameter baris perintah.
$longopts = \array_map(function ($key) {
    return "$key:"; // Tambahkan titik dua (:) di akhir setiap parameter untuk menunjukkan bahwa nilai diperlukan.
}, array_keys($optsdesc));

// Uraikan parameter baris perintah.
$options = getopt("", $longopts); 

// Periksa apakah parameter wajib telah dikonfigurasi.
foreach ($optsdesc as $key => $value) {
    if ($value['required'] === True && empty($options[$key])) {
        $help = $value['help'];
        echo "Error: the following arguments are required: --$key, $help"; // Tentukan bahwa parameter wajib belum dikonfigurasi.
        exit(1); 
    }
}

// Dapatkan nilai parameter baris perintah.
$region = $options["region"]; // Wilayah tempat bucket berada.
$bucket = $options["bucket"]; // Nama bucket.

// Gunakan variabel lingkungan untuk memuat ID AccessKey dan Rahasia AccessKey.
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

// Gunakan konfigurasi default SDK.
$cfg = Oss\Config::loadDefault();

// Tentukan penyedia kredensial.
$cfg->setCredentialsProvider($credentialsProvider);

// Tentukan wilayah.
$cfg->setRegion($region);

// Tentukan endpoint jika endpoint disediakan.
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]);
}

// Buat instance OSSClient.
$client = new Oss\Client($cfg);

// Buat objek InitiateBucketWormRequest untuk membuat kebijakan retensi untuk bucket dan atur periode retensi kebijakan retensi menjadi tiga hari.
$request = new Oss\Models\InitiateBucketWormRequest(
    bucket: $bucket, 
    initiateWormConfiguration: new Oss\Models\InitiateWormConfiguration(
        retentionPeriodInDays: 3 // Atur periode retensi menjadi tiga hari.
));

// Gunakan metode initiateBucketWorm untuk membuat kebijakan retensi untuk bucket.
$result = $client->initiateBucketWorm($request);

// Tampilkan hasil yang dikembalikan.
printf(
    'status code:' . $result->statusCode . PHP_EOL . // Kode status HTTP yang dikembalikan.
    'request id:' . $result->requestId . PHP_EOL . // ID permintaan, yaitu pengidentifikasi unik permintaan.
    'worm id:' . $result->wormId // ID kebijakan retensi.
);

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

const client = new OSS({
  // Atur region ke wilayah tempat bucket berada. Misalnya, jika bucket berada di wilayah China (Hangzhou), atur region ke oss-cn-hangzhou.
  region: 'yourregion',
  // Dapatkan kredensial akses dari variabel lingkungan. Sebelum menjalankan kode ini, pastikan variabel lingkungan OSS_ACCESS_KEY_ID dan OSS_ACCESS_KEY_SECRET telah diatur.
  accessKeyId: process.env.OSS_ACCESS_KEY_ID,
  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,  
  authorizationV4: true,
  // Atur bucket ke nama bucket Anda.
  bucket: 'yourBucketName',
});
// Buat kebijakan retensi data.
async function initiateBucketWorm() {
 // Atur bucket ke nama bucket Anda.
  const bucket = 'yourbucketname'
  // Tentukan periode retensi dalam hari.
  const days = '<Retention Days>'
    const res = await client.initiateBucketWorm(bucket, days)
  console.log(res.wormId)
}

initiateBucketWorm()

import argparse
import alibabacloud_oss_v2 as oss

# Buat parser parameter baris perintah dan jelaskan tujuan skrip. Contoh ini menjelaskan cara menggunakan fitur Write Once Read Many (WORM) untuk membuat kebijakan retensi untuk bucket.
parser = argparse.ArgumentParser(description="initiate bucket worm sample")

# Tentukan parameter --region, yang menentukan wilayah tempat bucket berada. Parameter baris perintah ini wajib.
parser.add_argument('--region', help='Wilayah tempat bucket berada.', required=True)
# Tentukan parameter --bucket, yang menentukan nama bucket. Parameter baris perintah ini wajib.
parser.add_argument('--bucket', help='Nama bucket.', required=True)
# Tentukan parameter --endpoint, yang menentukan endpoint wilayah tempat bucket berada. Parameter baris perintah ini opsional.
parser.add_argument('--endpoint', help='Nama domain yang dapat digunakan layanan lain untuk mengakses OSS')
# Tentukan parameter --retention_period_in_days, yang menentukan jumlah hari objek dapat disimpan. Parameter baris perintah ini wajib.
parser.add_argument('--retention_period_in_days', help='Jumlah hari objek dapat disimpan.', required=True)

def main():
    # Uraikan parameter baris perintah untuk mendapatkan nilai yang ditentukan pengguna.
    args = parser.parse_args()

    # Muat informasi autentikasi yang diperlukan untuk mengakses OSS dari variabel lingkungan.
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # Gunakan konfigurasi default SDK untuk membuat objek konfigurasi dan tentukan penyedia kredensial.
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region

    # Jika endpoint kustom disediakan, ubah parameter endpoint dalam objek konfigurasi.
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # Gunakan konfigurasi di atas untuk menginisialisasi instance OSSClient dan izinkan instance berinteraksi dengan OSS.
    client = oss.Client(cfg)

    # Kirim permintaan untuk membuat kebijakan retensi untuk bucket.
    result = client.initiate_bucket_worm(oss.InitiateBucketWormRequest(
        bucket=args.bucket, # Nama bucket.
        initiate_worm_configuration=oss.InitiateWormConfiguration(
            retention_period_in_days=int(args.retention_period_in_days), # Jumlah hari objek dapat disimpan. Atur nilainya sebagai bilangan bulat.
        ),
    ))

    # Tampilkan kode status HTTP operasi, ID permintaan, dan ID kebijakan retensi untuk memeriksa status permintaan.
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' worm id: {result.worm_id}'
    )

# Panggil fungsi main untuk memulai logika pemrosesan saat skrip dijalankan langsung.
if __name__ == "__main__":
    main() # Tentukan titik masuk dalam fungsi skrip. Alur program kontrol dimulai di sini.

package main

import (
	"log"

	"github.com/aliyun/aliyun-oss-go-sdk/oss"
)

func main() {
	// Dapatkan kredensial akses dari variabel lingkungan. Sebelum menjalankan kode contoh ini, pastikan variabel lingkungan OSS_ACCESS_KEY_ID dan OSS_ACCESS_KEY_SECRET telah diatur.
	provider, err := oss.NewEnvironmentVariableCredentialsProvider()
	if err != nil {
		log.Fatalf("Error creating credentials provider: %v", err)
	}

	// Buat instance OSSClient.
	// Atur yourEndpoint ke Endpoint bucket. Misalnya, untuk wilayah China (Hangzhou), atur Endpoint ke https://oss-cn-hangzhou.aliyuncs.com. Untuk wilayah lain, gunakan Endpoint aktual.
	// Atur yourRegion ke wilayah tempat bucket berada. Misalnya, untuk wilayah China (Hangzhou), atur wilayah ke cn-hangzhou. Untuk wilayah lain, gunakan wilayah aktual.
	clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
	clientOptions = append(clientOptions, oss.Region("yourRegion"))
	// Atur versi signature.
	clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
	client, err := oss.New("yourEndpoint", "", "", clientOptions...)
	if err != nil {
		log.Fatalf("Error creating OSS client: %v", err)
	}

	// Tentukan nama bucket tempat Anda ingin mengonfigurasi kebijakan retensi.
	bucketName := "<yourBucketName>"

	// Atur periode retensi objek menjadi 60 hari.
	result, err := client.InitiateBucketWorm(bucketName, 60)
	if err != nil {
		log.Fatalf("Error initiating bucket WORM: %v", err)
	}

	log.Println("WORM policy initiated successfully:", result)
}

#include <alibabacloud/oss/OssClient.h>
using namespace AlibabaCloud::OSS;

int main(void)
{
    /* Inisialisasi informasi akun OSS. */
            
    /* Atur Endpoint ke endpoint wilayah tempat bucket berada. Misalnya, jika bucket berada di wilayah China (Hangzhou), atur Endpoint ke https://oss-cn-hangzhou.aliyuncs.com. */
    std::string Endpoint = "yourEndpoint";
    /* Atur Region ke wilayah tempat bucket berada. Misalnya, jika bucket berada di wilayah China (Hangzhou), atur Region ke cn-hangzhou. */
    std::string Region = "yourRegion";
    /* Masukkan nama bucket. Misalnya, examplebucket. */
    std::string BucketName = "examplebucket";

      /* Inisialisasi resource seperti jaringan. */
      InitializeSdk();

      ClientConfiguration conf;
      conf.signatureVersion = SignatureVersionType::V4;
      /* Dapatkan kredensial akses dari variabel lingkungan. Sebelum menjalankan kode ini, pastikan variabel lingkungan OSS_ACCESS_KEY_ID dan OSS_ACCESS_KEY_SECRET telah diatur. */
    auto credentialsProvider = std::make_shared<EnvironmentVariableCredentialsProvider>();
    OssClient client(Endpoint, credentialsProvider, conf);
    client.SetRegion(Region);
  
      /* Buat kebijakan retensi data dan atur periode perlindungan objek menjadi 1 hari. */
      auto outcome = client.InitiateBucketWorm(InitiateBucketWormRequest(BucketName, 1));

      if (outcome.isSuccess()) {      
            std::cout << " InitiateBucketWorm success " << std::endl;
            std::cout << "WormId:" << outcome.result().WormId() << std::endl;
      }
      else {
        /* Tangani pengecualian. */
        std::cout << "InitiateBucketWorm fail" <<
        ",code:" << outcome.error().Code() <<
        ",message:" << outcome.error().Message() <<
        ",requestId:" << outcome.error().RequestId() << std::endl;
        return -1;
      }

      /* Lepaskan resource seperti jaringan. */
      ShutdownSdk();
      return 0;
}

ossutil api initiate-bucket-worm --bucket examplebucket --initiate-worm-configuration "{\"RetentionPeriodInDays\":\"365\"}"

API Terkait

Operasi di atas didasarkan pada operasi API. Jika program Anda memiliki persyaratan kustomisasi tinggi, Anda dapat langsung membuat permintaan REST API. Untuk membuat permintaan REST API, Anda harus menulis kode secara manual untuk menghitung signature. Untuk informasi selengkapnya, lihat InitiateBucketWorm.

Bekerja dengan versioning

Dalam skenario seperti memberikan perlindungan versi data untuk sistem backup seperti Veeam, melacak catatan modifikasi aset seperti diagram desain sirkuit, atau memenuhi persyaratan pengarsipan kepatuhan di industri keuangan, Anda sering perlu mengizinkan pembaruan data kontinu sekaligus memastikan bahwa semua versi historis bersifat immutable dan tidak dapat dihapus. Untuk mencapai hal ini, Anda dapat membuat kebijakan retensi dan mengaktifkan versioning untuk bucket secara bersamaan. Versioning memastikan bahwa ketika objek ditimpa atau dihapus, versi lamanya tetap disimpan sebagai versi historis, bukan dihapus secara fisik. Kebijakan retensi menetapkan periode perlindungan untuk semua versi objek dalam bucket. Selama periode ini, tidak ada versi yang dapat dihapus atau dimodifikasi.

Ketika versioning dan kebijakan retensi dikonfigurasi untuk bekerja bersama, mereka mengikuti prinsip-prinsip berikut:

• Urutan pengaktifan fitur: Tidak ada batasan urutan pengaktifan versioning dan kebijakan retensi. Anda dapat mengonfigurasinya secara fleksibel sesuai kebutuhan.

• Batasan transisi status:

  • Setelah kebijakan retensi dikunci, Anda tidak dapat mengubah status versioning dari "Enabled" menjadi "Suspended".

  • Anda dapat mengaktifkan kebijakan retensi untuk bucket yang versioning-nya "Suspended". Setelah kebijakan diaktifkan, Anda dapat mengubah status versioning menjadi "Enabled".

• Mekanisme perlindungan versi objek:

  • Kebijakan retensi melindungi semua versi objek. Tidak ada versi yang dapat dihapus atau dimodifikasi selama periode perlindungan.

  • Anda dapat mengunggah objek dengan nama yang sama untuk membuat versi baru. Versi baru tersebut juga dilindungi oleh kebijakan retensi.

  • Kebijakan retensi tidak berlaku untuk delete markers. Penghapusan delete markers tidak dibatasi oleh kebijakan retensi.

• Sinergi replikasi data:

  • Bucket sumber dan tujuan mendukung konfigurasi independen untuk versioning dan kebijakan retensi.

  • Informasi versi ditransmisikan secara normal selama replikasi. Bucket tujuan mengelola versi berdasarkan konfigurasinya sendiri.

  • Operasi penghapusan versi di bucket sumber tidak disinkronkan ke bucket tujuan yang memiliki kebijakan retensi yang diaktifkan.

FAQ