aliyun_oss v0.2.0 Aliyun.Oss.Bucket

Bucket 相关操作

Link to this section Summary

Types

error()

Functions

get_bucket(bucket, query_params \\ %{}, sub_resources \\ %{})

GetBucket(ListObject) 接口可用来列出 Bucket中所有Object的信息。

get_bucket_acl(bucket)

GetBucketAcl 接口用来获取某个Bucket的访问权限。

get_bucket_info(bucket)

GetBucketInfo 接口用于查看bucket的相关信息。可查看内容包含如下：

get_bucket_lifecycle(bucket)

GetBucketLifecycle 用于查看Bucket的Lifecycle配置。

get_bucket_location(bucket)

GetBucketLocation GetBucketLocation用于查看Bucket所属的数据中心位置信息。

get_bucket_logging(bucket)

GetBucketLogging 用于查看Bucket的访问日志配置情况。

get_bucket_referer(bucket)

GetBucketReferer 操作用于查看bucket的Referer相关配置。

get_bucket_website(bucket)

GetBucketWebsite 接口用于查看bucket的静态网站托管状态以及跳转规则。

list_buckets(query_params \\ %{})

GetService (ListBuckets) 对于服务地址作Get请求可以返回请求者拥有的所有Bucket。

Link to this section Types

error()

error() :: Aliyun.Oss.Client.Error.t() | atom()

Link to this section Functions

get_bucket(bucket, query_params \\ %{}, sub_resources \\ %{})

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

GetBucket(ListObject) 接口可用来列出 Bucket中所有Object的信息。

Examples

iex> Aliyun.Oss.Bucket.get_bucket("some-bucket", %{"prefix" => "foo/"})
{:ok, %Aliyun.Oss.Client.Response{
    data: %{
      "ListAllMyBucketsResult" => %{
        "Contents" => [
          %{
            "ETag" => ""D410293F000B000D00D"",
            "key" => "foo/bar",
            "LastModified" => "2018-09-12T02:59:41.000Z",
            "Owner" => %{"DislayName" => "11111111", "ID" => "11111111"},
            "Size" => "12345",
            "StorageClass" => "IA",
            "Type" => "Normal"
          },
          ...
        ],
        "Delimiter" => nil,
        "IsTruncated" => true,
        "Marker" => nil,
        "MaxKeys" => 100,
        "Name" => "some-bucket",
        "NextMarker" => "XXXXX",
        "Prefix" => "foo/"
      }
    },
    headers: [
      {"Date", "Wed, 05 Dec 2018 02:34:57 GMT"},
      ...
    ]
  }
}

iex> Aliyun.Oss.Bucket.get_bucket("unknown-bucket")
{:error,
  %Aliyun.Oss.Client.Error{
    status_code: 404,
    parsed_details: %{
      "ListBucketResult" => %{
        "BucketName" => "unknown-bucket",
        "Code" => "NoSuchBucket",
        "HostId" => "unknown-bucket.oss-cn-shenzhen.aliyuncs.com",
        "Message" => "The specified bucket does not exist.",
        "RequestId" => "5BFF89955E29FF66F10B9763"
      }
    },
    body: "<?xml version="1.0" encoding="UTF-8"?>...</xml>"
  }
}

注：所有 GetBucketXXX 相关操作亦可由此接口实现, 即 Bucket.get_bucket_acl(“some-bucket”) 等同于 Bucket.get_bucket(“some-bucket”, %{}, %{“acl” => nil})

get_bucket_acl(bucket)

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

GetBucketAcl 接口用来获取某个Bucket的访问权限。

Examples

iex> Aliyun.Oss.Bucket.get_bucket_acl("some-bucket")
{:ok, %Aliyun.Oss.Client.Response{
    data: %{
      "AccessControlPolicy" => %{
        "AccessControlList" => %{"Grant" => "private"},
        "Owner" => %{"DislayName" => "11111111", "ID" => "11111111"}
      }
    },
    headers: [
      {"Date", "Wed, 05 Dec 2018 02:34:57 GMT"}
    ]
  }
}

get_bucket_info(bucket)

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

GetBucketInfo 接口用于查看bucket的相关信息。可查看内容包含如下：

创建时间
外网访问Endpoint
内网访问Endpoint
bucket的拥有者信息
bucket的ACL（AccessControlList）

Examples

iex> Aliyun.Oss.Bucket.get_bucket_info("some-bucket")
{:ok, %Aliyun.Oss.Client.Response{
  data: %{
    "BucketInfo" => %{
      "Bucket" => %{
        "AccessControlList" => %{"Grant" => "private"},
        "Comment" => nil,
        "CreationDate" => "2018-08-29T01:52:03.000Z",
        "DataRedundancyType" => "LRS",
        "ExtranetEndpoint" => "oss-cn-shenzhen.aliyuncs.com",
        "IntranetEndpoint" => "oss-cn-shenzhen-internal.aliyuncs.com",
        "Location" => "oss-cn-shenzhen",
        "Name" => "some-bucket",
        "Owner" => %{
          "DisplayName" => "11111111",
          "ID" => "11111111"
        },
        "StorageClass" => "IA"
      }
    }
  },
  headers: [
    {"Date", "Wed, 05 Dec 2018 02:34:57 GMT"}
  ]
}

get_bucket_lifecycle(bucket)

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

GetBucketLifecycle 用于查看Bucket的Lifecycle配置。

Examples

iex> Aliyun.Oss.Bucket.get_bucket_lifecycle("some-bucket")
{:ok,
%{
  "LifecycleConfiguration" => %{
    "Rule" => %{
      "ID" => "delete after one day",
      "Prefix" => "logs/",
      "Status" => "Enabled",
      "Expiration" => %{
        "Days" => "1"
      }
    }
  }
}}

get_bucket_location(bucket)

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

GetBucketLocation GetBucketLocation用于查看Bucket所属的数据中心位置信息。

Examples

iex> Aliyun.Oss.Bucket.get_bucket_location("some-bucket")
{:ok, %Aliyun.Oss.Client.Response{
    data: %{"LocationConstraint" => "oss-cn-shenzhen"},
    headers: [
      {"Date", "Wed, 05 Dec 2018 02:34:57 GMT"}
    ]
  }
}

get_bucket_logging(bucket)

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

GetBucketLogging 用于查看Bucket的访问日志配置情况。

Examples

iex> Aliyun.Oss.Bucket.get_bucket_logging("some-bucket")
{:ok,
%{
  "BucketLoggingStatus" => %{
    "LoggingEnabled" => %{
      "TargetBucket" => "some-bucket",
      "TargetPrefix" => "oss-accesslog/"
    }
  }
}}

get_bucket_referer(bucket)

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

GetBucketReferer 操作用于查看bucket的Referer相关配置。

Examples

iex> Aliyun.Oss.Bucket.get_bucket_referer("some-bucket")
{:ok,
%{
  "RefererConfiguration" => %{
    "AllowEmptyReferer" => "true",
    "RefererList" => nil
  }
}}

get_bucket_website(bucket)

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

GetBucketWebsite 接口用于查看bucket的静态网站托管状态以及跳转规则。

Examples

iex> Aliyun.Oss.Bucket.get_bucket_website("some-bucket")
{:ok, %{"WebsiteConfiguration" => %{"IndexDocument" => %{"Suffix" => "index.html"}}}}

iex> Aliyun.Oss.Bucket.get_bucket_website("unkown-bucket")
{:error,
  %Aliyun.Oss.Client.Error{
    status_code: 404,
    parsed_details: %{
      "BucketName" => "unkown-bucket",
      "Code" => "NoSuchBucket",
      "HostId" => "unkown-bucket.oss-cn-shenzhen.aliyuncs.com",
      "Message" => "The specified bucket does not exist.",
      "RequestId" => "5C0000000000000000000000"
    },
    body: "<?xml version="1.0" encoding="UTF-8"?>...</xml>"
  }
}

list_buckets(query_params \\ %{})

list_buckets(map()) ::
  {:error, error()} | {:ok, Aliyun.Oss.Client.Response.t()}

GetService (ListBuckets) 对于服务地址作Get请求可以返回请求者拥有的所有Bucket。

Examples

iex> Aliyun.Oss.Bucket.list_buckets(%{"max-keys" => 5})
{:ok, %Aliyun.Oss.Client.Response{
    data: %{
      "Buckets" => %{
        "Bucket" => [
          %{
            "CreationDate" => "2018-10-12T07:57:51.000Z",
            "ExtranetEndpoint" => "oss-cn-shenzhen.aliyuncs.com",
            "IntranetEndpoint" => "oss-cn-shenzhen-internal.aliyuncs.com",
            "Location" => "oss-cn-shenzhen",
            "Name" => "XXXXX",
            "StorageClass" => "Standard"
          },
          ...
        ]
      },
      "IsTruncated" => true,
      "Marker" => nil,
      "MaxKeys" => 5,
      "NextMarker" => "XXXXX",
      "Owner" => %{"DislayName" => "11111111", "ID" => "11111111"},
      "Prefix" => nil
    },
    headers: [
      {"Date", "Wed, 05 Dec 2018 02:34:57 GMT"},
      ...
    ]
  }
}

iex> Aliyun.Oss.Bucket.list_buckets(%{"max-keys" => 100000})
{:error,
  %Aliyun.Oss.Client.Error{
    status_code: 400,
    parsed_details: %{
      "ArgumentName" => "max-keys",
      "ArgumentValue" => "100000",
      "Code" => "InvalidArgument",
      "HostId" => "oss-cn-shenzhen.aliyuncs.com",
      "Message" => "Argument max-keys must be an integer between 1 and 1000.",
      "RequestId" => "5BFF8912332CCD8D560F65D9"
    },
    body: "<?xml version="1.0" encoding="UTF-8"?>...</xml>"
  }
}