Aliyun.Oss.Bucket.WORM (aliyun_oss v1.0.0)

Bucket WORM 相关操作

Link to this section Summary

Types

error()

Functions

abort(bucket)

AbortBucketWorm用于删除未锁定的合规保留策略。

complete(bucket, worm_id)

CompleteBucketWorm用于锁定合规保留策略。

extend(bucket, worm_id, days)

ExtendBucketWorm用于延长已锁定的合规保留策略对应Bucket中Object的保留天数。

get(bucket)

GetBucketWorm用于获取指定存储空间（Bucket）的合规保留策略信息。

initiate(bucket, days)

InitiateBucketWorm用于新建一条合规保留策略。

Link to this section Types

error()

Specs

error() ::
  %Aliyun.Oss.Client.Error{
    body: String.t(),
    parsed_details: map(),
    status_code: integer()
  }
  | atom()

Link to this section Functions

abort(bucket)

Specs

abort(String.t()) :: {:error, error()} | {:ok, Aliyun.Oss.Client.Response.t()}

AbortBucketWorm用于删除未锁定的合规保留策略。

Examples

iex> Aliyun.Oss.Bucket.WORM.abort("some-bucket", "report1")
{:ok, %Aliyun.Oss.Client.Response{
  data: "",
  headers: [
    {"Server", "AliyunOSS"},
    ...
  ]
}}

complete(bucket, worm_id)

Specs

complete(String.t(), String.t()) ::
  {:error, error()} | {:ok, Aliyun.Oss.Client.Response.t()}

CompleteBucketWorm用于锁定合规保留策略。

Examples

iex> Aliyun.Oss.Bucket.WORM.complete("some-bucket", "worm_id_1")
{:ok, %Aliyun.Oss.Client.Response{
  data: "",
  headers: [
    {"Server", "AliyunOSS"},
    ...
  ]
}}

extend(bucket, worm_id, days)

Specs

extend(String.t(), String.t(), integer()) ::
  {:error, error()} | {:ok, Aliyun.Oss.Client.Response.t()}

ExtendBucketWorm用于延长已锁定的合规保留策略对应Bucket中Object的保留天数。

Examples

iex> Aliyun.Oss.Bucket.WORM.extend("some-bucket", "worm_id_1")
{:ok,
%Aliyun.Oss.Client.Response{
  data: "",
  headers: [
    {"Server", "AliyunOSS"},
    ...
  ]
}}

get(bucket)

Specs

get(String.t()) :: {:error, error()} | {:ok, Aliyun.Oss.Client.Response.t()}

GetBucketWorm用于获取指定存储空间（Bucket）的合规保留策略信息。

Examples

iex> Aliyun.Oss.Bucket.WORM.get("some-bucket")
{:ok, %Aliyun.Oss.Client.Response{
  data: %{
    "WormConfiguration" => %{
      "CreationDate" => "2021-01-19T08:34:39.000Z",
      "ExpirationDate" => "2021-01-20T08:34:39.000Z",
      "RetentionPeriodInDays" => "1",
      "State" => "InProgress",
      "WormId" => "20000000000000000000000000000000"
    }
  },
  headers: [
    {"Date", "Wed, 05 Dec 2018 02:34:57 GMT"},
    ...
  ]
}}

initiate(bucket, days)

Specs

initiate(String.t(), integer()) ::
  {:error, error()} | {:ok, Aliyun.Oss.Client.Response.t()}

InitiateBucketWorm用于新建一条合规保留策略。

Examples

iex> Aliyun.Oss.Bucket.WORM.initiate("some-bucket", 1)
{:ok, %Aliyun.Oss.Client.Response{
  data: "",
  headers: [
    {"Server", "AliyunOSS"},
    {"x-oss-worm-id", "F0000000000000000000000000000000"},
    ...
  ]
}}