aliyun_oss v2.0.0

Aliyun.Oss.Bucket.Referer (aliyun_oss v2.0.0)

Bucket operations - Referer.

Link to this section Summary

Types

error()

Functions

get(config, bucket)

GetBucketReferer - gets the Referer configurations of a bucket.

put(config, bucket, xml_body)

PutBucketReferer - configures the Referer whitelist of a bucket.

Link to this section Types

Link to this type

error()

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

Link to this section Functions

Link to this function

get(config, bucket)

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

GetBucketReferer - gets the Referer configurations of a bucket.

examples

 Examples 

iex> Aliyun.Oss.Bucket.Referer.get("some-bucket")
{:ok, %Aliyun.Oss.Client.Response{
  data: %{
    "RefererConfiguration" => %{
      "AllowEmptyReferer" => "true",
      "RefererList" => nil
    }
  },
  headers: [
    {"Date", "Wed, 05 Dec 2018 02:34:57 GMT"},
    ...
  ]
}}
Link to this function

put(config, bucket, xml_body)

@spec put(Aliyun.Oss.Config.t(), String.t(), String.t()) ::
  {:error, error()} | {:ok, Aliyun.Oss.Client.Response.t()}

PutBucketReferer - configures the Referer whitelist of a bucket.

examples

 Examples 

iex> xml_body = """
...> <?xml version="1.0" encoding="UTF-8"?>
...> <RefererConfiguration>
...> <AllowEmptyReferer>true</AllowEmptyReferer >
...>     <RefererList>
...>         <Referer> http://www.aliyun.com</Referer>
...>         <Referer> https://www.aliyun.com</Referer>
...>         <Referer> http://www.*.com</Referer>
...>         <Referer> https://www.?.aliyuncs.com</Referer>
...>     </RefererList>
...> </RefererConfiguration>
...>  """
iex> Aliyun.Oss.Bucket.Referer.put("some-bucket", xml_body)
{:ok,
%Aliyun.Oss.Client.Response{
  data: "",
  headers: [
    {"Server", "AliyunOSS"},
    {"Date", "Fri, 11 Jan 2019 05:05:50 GMT"},
    {"Content-Length", "0"},
    {"Connection", "keep-alive"},
    {"x-oss-request-id", "5C0000000000000000000000"},
    {"x-oss-server-time", "63"}
  ]
}}