新建合规保留策略

您可以通过API级命令新建合规保留策略。

注意事项

  • 要新建合规保留策略,您必须有oss:InitiateBucketWorm权限。具体操作,请参见为RAM用户授权自定义的权限策略

  • 对象存储OSS支持WORM(Write Once Read Many)特性,允许以不可删除、不可篡改的方式保存和使用数据。OSS允许针对存储空间(Bucket)设置基于时间的合规保留策略,保护周期为1天到70年。

  • 当基于时间的合规保留策略创建24小时后未提交锁定,则该策略自动失效。当合规保留策略锁定后,您可以在Bucket中上传和读取文件(Object),但是在Object的保留时间到期之前,不允许删除Object及合规保留策略。Object的保留时间到期后,才可以删除Object。关于合规保留策略的更多信息,请参见保留策略

  • 同一个Bucket中,版本控制和合规保留策略无法同时配置。如果Bucket已开启版本控制功能,则无法再配置保留策略。关于版本控制功能更多信息,请参见版本控制概述

命令格式

ossutil api initiate-bucket-worm --bucket value --initiate-worm-configuration value [flags]

参数

类型

说明

--bucket

string

Bucket名称。

--initiate-worm-configuration

string

请求体。

说明

initiate-bucket-worm 命令对应API接口InitiateBucketWorm。关于API中的具体参数含义,请参见InitiateBucketWorm

--initiate-worm-configuration

--initiate-worm-configuration配置选项既支持XML语法也支持JSON语法:

  • XML语法:

    <InitiateWormConfiguration>
      <RetentionPeriodInDays>integer</RetentionPeriodInDays>
    </InitiateWormConfiguration>
  • JSON语法:

    {
      "RetentionPeriodInDays": integer
    }
说明

关于支持的全局命令行选项,请参见支持的全局命令行选项

使用示例

为存储空间examplebucket新建一条合规保留策略。

  • 使用XML配置文件,initiate-worm-configuration.xml内容如下:

    <?xml version="1.0" encoding="UTF-8"?>
    <InitiateWormConfiguration>
      <RetentionPeriodInDays>365</RetentionPeriodInDays>
    </InitiateWormConfiguration>

    命令示例如下:

    ossutil api initiate-bucket-worm --bucket examplebucket --initiate-worm-configuration file://initiate-worm-configuration.xml
  • 使用JSON配置文件,initiate-worm-configuration.json内容如下:

    {
            "RetentionPeriodInDays": "365"
    }

    命令示例如下:

    ossutil api initiate-bucket-worm --bucket examplebucket --initiate-worm-configuration file://initiate-worm-configuration.json
  • 使用JSON配置参数,命令示例如下:

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