QingHTTP: Qing HTTP Requests

Description Usage Arguments Details Value

Description

This is the workhorse function for executing API requests for Qing.

Usage

1
2
3
4
5
6
7
QingHTTP(verb = "GET", bucket = "", path = "", folder = "",
  query = NULL, headers = list(), request_body = "", accelerate = FALSE,
  region = Sys.getenv("Qstor_DEFAULT_REGION", "pek3a"),
  key = Sys.getenv("Qstor_ACCESS_KEY_ID"),
  secret = Sys.getenv("Qstor_SECRET_ACCESS_KEY"),
  session_token = Sys.getenv("Qstor_SESSION_TOKEN"), parse_response = TRUE,
  ...)

Arguments

verb

A character string containing an HTTP verb, defaulting to “GET”.

bucket

A character string with the name of the bucket, or an object of class “qing_bucket”. If the latter and a region can be inferred from the bucket object attributes, then that region is used instead of region.

path

A character string with the name of the object to put in the bucket (sometimes called the object or 'key name' in the QingStor documentation.)

query

any queries, passed as a named list

headers

a list of request headers for the REST call.

request_body

character string of request body data.

accelerate

A logical indicating whether to use QingStor transfer acceleration, which can produce significant speed improvements for cross-country transfers. Acceleration only works with buckets that do not have dots in bucket name.

region

A character string containing the QingStor region. Ignored if region can be inferred from bucket. If missing, defaults to “us-east-1”.

key

A character string containing an QingStor Access Key ID. If missing, defaults to value stored in environment variable “Qstor_ACCESS_KEY_ID”.

secret

A character string containing an QingStor Secret Access Key. If missing, defaults to value stored in environment variable “Qstor_SECRET_ACCESS_KEY”.

parse_response

return the response as is, or parse and return as a list? Default is TRUE.

...

Additional arguments passed to an HTTP request function. such as GET.

Details

This is mostly an internal function for executing API requests. In almost all cases, users do not need to access this directly.

Value

the Qing response, or the relevant error.


zhangxing-love/QingStorRSDK_0.1 documentation built on May 4, 2019, 10:17 p.m.