View Source AliyunOpenAPI.Specs.OSS (aliyun_open_api v0.6.0)

Describes an OSS style API.

Read more at:

About spec_opts

spec_opts is a plain map for describing a RESTful API request.

Adding signature

This implementation has built-in V4 signature support, and it's controlled by the :sign_type option:

  • :header - add signature to the headers of request.
  • :url - add signature to the url of request.

V1 signature is not supported.

Required headers

All necessary headers of requests will be generated automatically. You don't have to specifically set them, unless you want to customize it.

Examples

Send a request for ListBucktets operation 

alias AliyunOpenAPI.Config
alias AliyunOpenAPI.Specs.OSS
alias AliyunOpenAPI.HTTP.Request
alias AliyunOpenAPI.HTTP.Client

config =
  Config.new!(
    access_key_id: "...",
    access_key_secret: "..."
  )

OSS.new!(config,
  sign_type: :header,
  region: "oss-us-west-1",
  endpoint: "https://oss-us-west-1.aliyuncs.com/",
  method: :get,
  path: "/"
)
|> Request.from_spec!()
|> Client.request()

Create a pre-signed url for GetObject operation 

alias AliyunOpenAPI.Config
alias AliyunOpenAPI.Specs.OSS
alias AliyunOpenAPI.HTTP.Request

config =
  Config.new!(
    access_key_id: "...",
    access_key_secret: "..."
  )

OSS.new!(config,
  sign_type: :url,
  region: "oss-us-west-1",
  bucket: "example-bucket",
  endpoint: "https://example-bucket.oss-us-west-1.aliyuncs.com/",
  method: :get,
  path: "/example-object",
  headers: %{
    "x-oss-expires" => 900
  }
)
|> Request.from_spec!()
|> Request.url()

Summary

Types

body()
bucket()
endpoint()

The base url that the request is sent to.

headers()
method()
path()
query()
region()
sign_type()
spec_opt()
spec_opts()
t()

Functions

new!(config, spec_opts)

Types

Link to this type

body()

View Source 
@type body() :: iodata() | nil
Link to this type

bucket()

View Source 
@type bucket() :: String.t() | nil
Link to this type

endpoint()

View Source 
@type endpoint() :: String.t()

The base url that the request is sent to.

Following formats are supported:

  • region URL, such as https://oss-us-west-1.aliyuncs.com.
  • virtual-hosted style URL, such as https://example-bucket.oss-us-west-1.aliyuncs.com.
  • custom domain name, such as https://www.example.com.
  • ...
Link to this type

headers()

View Source 
@type headers() :: %{
  optional(name :: String.t()) =>
    value :: nil | boolean() | number() | String.t()
}
Link to this type

method()

View Source 
@type method() :: String.t()
Link to this type

path()

View Source 
@type path() :: String.t()
Link to this type

query()

View Source 
@type query() :: %{
  optional(name :: String.t()) =>
    value :: nil | boolean() | number() | String.t()
}
Link to this type

region()

View Source 
@type region() :: String.t()
Link to this type

sign_type()

View Source 
@type sign_type() :: :header | :url
Link to this type

spec_opt()

View Source 
@type spec_opt() ::
  {:region, region()}
  | {:bucket, bucket()}
  | {:sign_type, sign_type()}
  | {:endpoint, endpoint()}
  | {:method, method()}
  | {:path, path()}
  | {:query, query()}
  | {:headers, headers()}
  | {:body, body()}
Link to this type

spec_opts()

View Source 
@type spec_opts() :: [spec_opt()]
Link to this type

t()

View Source 
@type t() :: %AliyunOpenAPI.Specs.OSS{
  body: body(),
  bucket: bucket(),
  config: AliyunOpenAPI.Config.t(),
  endpoint: endpoint(),
  headers: headers(),
  method: method(),
  path: path(),
  query: query(),
  region: region(),
  sign_type: sign_type()
}

Functions

Link to this function

new!(config, spec_opts)

View Source 
@spec new!(AliyunOpenAPI.Config.t(), spec_opts()) :: t()