api_specification.md

Table of Contents

• Bucket
  • Parameters
  • delete
  • deleteCNAME
    • Parameters
  • deleteCORS
  • deleteExternalMirror
  • deleteLifecycle
  • deleteLogging
  • deleteNotification
  • deletePolicy
  • deleteReplication
  • deleteMultipleObjects
    • Parameters
  • getACL
  • getCNAME
    • Parameters
  • getCORS
  • getExternalMirror
  • getLifecycle
  • getLogging
  • getNotification
  • getPolicy
  • getReplication
  • getStatistics
  • head
  • listMultipartUploads
    • Parameters
  • listObjects
    • Parameters
  • put
  • putACL
    • Parameters
  • putCNAME
    • Parameters
  • putCORS
    • Parameters
  • putExternalMirror
    • Parameters
  • putLifecycle
    • Parameters
  • putLogging
    • Parameters
  • putNotification
    • Parameters
  • putPolicy
    • Parameters
  • putReplication
    • Parameters
  • abortMultipartUpload
    • Parameters
  • appendObject
    • Parameters
  • completeMultipartUpload
    • Parameters
  • deleteObject
    • Parameters
  • getObject
    • Parameters
  • headObject
    • Parameters
  • imageProcess
    • Parameters
  • initiateMultipartUpload
    • Parameters
  • listMultipart
    • Parameters
  • optionsObject
    • Parameters
  • putObject
    • Parameters
  • uploadMultipart
    • Parameters
• QingStor
  • Parameters
  • listBuckets
    • Parameters

Bucket

Bucket Module

Parameters

• config Object object
• properties Object

delete

Delete a bucket. Documentation URL

Returns Promise axios response

deleteCNAME

Delete bucket CNAME setting of the bucket. Documentation URL

Parameters

• options Object User input options;
  • options.domain domain name

Returns Promise axios response

deleteCORS

Delete CORS information of the bucket. Documentation URL

Returns Promise axios response

deleteExternalMirror

Delete external mirror of the bucket. Documentation URL

Returns Promise axios response

deleteLifecycle

Delete Lifecycle information of the bucket. Documentation URL

Returns Promise axios response

deleteLogging

Delete bucket logging setting of the bucket. Documentation URL

Returns Promise axios response

deleteNotification

Delete Notification information of the bucket. Documentation URL

Returns Promise axios response

deletePolicy

Delete policy information of the bucket. Documentation URL

Returns Promise axios response

deleteReplication

Delete Replication information of the bucket. Documentation URL

Returns Promise axios response

deleteMultipleObjects

Delete multiple objects from the bucket. Documentation URL

Parameters

• options Object User input options;
  • options.Content-MD5 Object MD5sum
  • options.objects A list of keys to delete
  • options.quiet Whether to return the list of deleted objects

Returns Promise axios response

getACL

Get ACL information of the bucket. Documentation URL

Returns Promise axios response

getCNAME

Get bucket CNAME setting of the bucket. Documentation URL

Parameters

• options Object User input options;
  • options.type Limit the type used for query, normal will be recognized if empty.

Returns Promise axios response

getCORS

Get CORS information of the bucket. Documentation URL

Returns Promise axios response

getExternalMirror

Get external mirror of the bucket. Documentation URL

Returns Promise axios response

getLifecycle

Get Lifecycle information of the bucket. Documentation URL

Returns Promise axios response

getLogging

Get bucket logging setting of the bucket. Documentation URL

Returns Promise axios response

getNotification

Get Notification information of the bucket. Documentation URL

Returns Promise axios response

getPolicy

Get policy information of the bucket. Documentation URL

Returns Promise axios response

getReplication

Get Replication information of the bucket. Documentation URL

Returns Promise axios response

getStatistics

Get statistics information of the bucket. Documentation URL

Returns Promise axios response

head

Check whether the bucket exists and available. Documentation URL

Returns Promise axios response

listMultipartUploads

List multipart uploads in the bucket. Documentation URL

Parameters

• options Object User input options;
  • options.delimiter Put all keys that share a common prefix into a list
  • options.key_marker Limit results returned from the first key after key_marker sorted by alphabetical order
  • options.limit Results count limit
  • options.prefix Limits results to keys that begin with the prefix
  • options.upload_id_marker Limit results returned from the first uploading segment after upload_id_marker sorted by the time of upload_id

Returns Promise axios response

listObjects

Retrieve the object list in a bucket. Documentation URL

Parameters

• options Object User input options;
  • options.delimiter Put all keys that share a common prefix into a list
  • options.limit Results count limit
  • options.marker Limit results to keys that start at this marker
  • options.prefix Limits results to keys that begin with the prefix

Returns Promise axios response

put

Create a new bucket. Documentation URL

Returns Promise axios response

putACL

Set ACL information of the bucket. Documentation URL

Parameters

• options Object User input options;
  • options.acl Bucket ACL rules

Returns Promise axios response

putCNAME

Set bucket CNAME of the bucket. Documentation URL

Parameters

• options Object User input options;
  • options.domain The domain name to be bound to the bucket. The domain name must have been registered and not bound to another bucket.
  • options.type The purpose of the domain name to be bound. Currently supports two types, normal and website.

Returns Promise axios response

putCORS

Set CORS information of the bucket. Documentation URL

Parameters

• options Object User input options;
  • options.cors_rules Bucket CORS rules

Returns Promise axios response

putExternalMirror

Set external mirror of the bucket. Documentation URL

Parameters

• options Object User input options;
  • options.source_site Source site url

Returns Promise axios response

putLifecycle

Set Lifecycle information of the bucket. Documentation URL

Parameters

• options Object User input options;
  • options.rule Bucket Lifecycle rule

Returns Promise axios response

putLogging

Set bucket logging of the bucket. Documentation URL

Parameters

• options Object User input options;
  • options.target_bucket The name of the bucket used to store logs. The user must be the owner of the bucket.
  • options.target_prefix generated log files' common prefix

Returns Promise axios response

putNotification

Set Notification information of the bucket. Documentation URL

Parameters

• options Object User input options;
  • options.notifications Bucket Notification

Returns Promise axios response

putPolicy

Set policy information of the bucket. Documentation URL

Parameters

• options Object User input options;
  • options.statement Bucket policy statement

Returns Promise axios response

putReplication

Set Replication information of the bucket. Documentation URL

Parameters

• options Object User input options;
  • options.rules Bucket Replication rules

Returns Promise axios response

abortMultipartUpload

Abort multipart upload. Documentation URL

Parameters

• object_key string The object key
• options Object User input options;
  • options.upload_id Object multipart upload ID

Returns Promise axios response

appendObject

Append the Object. Documentation URL

Parameters

• object_key string The object key
• options Object User input options;
  • options.Content-Length Object content size
  • options.Content-MD5 Object MD5sum
  • options.Content-Type Object content type
  • options.X-QS-Storage-Class Specify the storage class for object
  • options.position Object append position

Returns Promise axios response

completeMultipartUpload

Complete multipart upload. Documentation URL

Parameters

• object_key string The object key
• options Object User input options;
  • options.ETag MD5sum of the object part
  • options.X-QS-Encryption-Customer-Algorithm Encryption algorithm of the object
  • options.X-QS-Encryption-Customer-Key Encryption key of the object
  • options.X-QS-Encryption-Customer-Key-MD5 MD5sum of encryption key
  • options.upload_id Object multipart upload ID
  • options.object_parts Object parts

Returns Promise axios response

deleteObject

Delete the object. Documentation URL

Parameters

• object_key string The object key

Returns Promise axios response

getObject

Retrieve the object. Documentation URL

Parameters

• object_key string The object key
• options Object User input options;
  • options.If-Match Check whether the ETag matches
  • options.If-Modified-Since Check whether the object has been modified
  • options.If-None-Match Check whether the ETag does not match
  • options.If-Unmodified-Since Check whether the object has not been modified
  • options.Range Specified range of the object
  • options.X-QS-Encryption-Customer-Algorithm Encryption algorithm of the object
  • options.X-QS-Encryption-Customer-Key Encryption key of the object
  • options.X-QS-Encryption-Customer-Key-MD5 MD5sum of encryption key
  • options.response-cache-control Specified the Cache-Control response header
  • options.response-content-disposition Specified the Content-Disposition response header
  • options.response-content-encoding Specified the Content-Encoding response header
  • options.response-content-language Specified the Content-Language response header
  • options.response-content-type Specified the Content-Type response header
  • options.response-expires Specified the Expires response header

Returns Promise axios response

headObject

Check whether the object exists and available. Documentation URL

Parameters

• object_key string The object key
• options Object User input options;
  • options.If-Match Check whether the ETag matches
  • options.If-Modified-Since Check whether the object has been modified
  • options.If-None-Match Check whether the ETag does not match
  • options.If-Unmodified-Since Check whether the object has not been modified
  • options.X-QS-Encryption-Customer-Algorithm Encryption algorithm of the object
  • options.X-QS-Encryption-Customer-Key Encryption key of the object
  • options.X-QS-Encryption-Customer-Key-MD5 MD5sum of encryption key

Returns Promise axios response

imageProcess

Image process with the action on the object Documentation URL

Parameters

• object_key string The object key
• options Object User input options;
  • options.If-Modified-Since Check whether the object has been modified
  • options.action Image process action
  • options.response-cache-control Specified the Cache-Control response header
  • options.response-content-disposition Specified the Content-Disposition response header
  • options.response-content-encoding Specified the Content-Encoding response header
  • options.response-content-language Specified the Content-Language response header
  • options.response-content-type Specified the Content-Type response header
  • options.response-expires Specified the Expires response header

Returns Promise axios response

initiateMultipartUpload

Initial multipart upload on the object. Documentation URL

Parameters

• object_key string The object key
• options Object User input options;
  • options.Content-Type Object content type
  • options.X-QS-Encryption-Customer-Algorithm Encryption algorithm of the object
  • options.X-QS-Encryption-Customer-Key Encryption key of the object
  • options.X-QS-Encryption-Customer-Key-MD5 MD5sum of encryption key
  • options.X-QS-MetaData User-defined metadata
  • options.X-QS-Storage-Class Specify the storage class for object

Returns Promise axios response

listMultipart

List object parts. Documentation URL

Parameters

• object_key string The object key
• options Object User input options;
  • options.limit Limit results count
  • options.part_number_marker Object multipart upload part number
  • options.upload_id Object multipart upload ID

Returns Promise axios response

optionsObject

Check whether the object accepts a origin with method and header. Documentation URL

Parameters

• object_key string The object key
• options Object User input options;
  • options.Access-Control-Request-Headers Request headers
  • options.Access-Control-Request-Method Request method
  • options.Origin Request origin

Returns Promise axios response

putObject

Upload the object. Documentation URL

Parameters

• object_key string The object key
• options Object User input options;
  • options.Cache-Control Object cache control
  • options.Content-Encoding Object content encoding
  • options.Content-Length Object content size
  • options.Content-MD5 Object MD5sum
  • options.Content-Type Object content type
  • options.Expect Used to indicate that particular server behaviors are required by the client
  • options.X-QS-Copy-Source Copy source, format (//)
  • options.X-QS-Copy-Source-Encryption-Customer-Algorithm Encryption algorithm of the object
  • options.X-QS-Copy-Source-Encryption-Customer-Key Encryption key of the object
  • options.X-QS-Copy-Source-Encryption-Customer-Key-MD5 MD5sum of encryption key
  • options.X-QS-Copy-Source-If-Match Check whether the copy source matches
  • options.X-QS-Copy-Source-If-Modified-Since Check whether the copy source has been modified
  • options.X-QS-Copy-Source-If-None-Match Check whether the copy source does not match
  • options.X-QS-Copy-Source-If-Unmodified-Since Check whether the copy source has not been modified
  • options.X-QS-Encryption-Customer-Algorithm Encryption algorithm of the object
  • options.X-QS-Encryption-Customer-Key Encryption key of the object
  • options.X-QS-Encryption-Customer-Key-MD5 MD5sum of encryption key
  • options.X-QS-Fetch-If-Unmodified-Since Check whether fetch target object has not been modified
  • options.X-QS-Fetch-Source Fetch source, should be a valid url
  • options.X-QS-MetaData User-defined metadata
  • options.X-QS-Metadata-Directive Use for modified metadata, valid (COPY/REPLACE)
  • options.X-QS-Move-Source Move source, format (//)
  • options.X-QS-Storage-Class Specify the storage class for object

Returns Promise axios response

uploadMultipart

Upload object multipart. Documentation URL

Parameters

• object_key string The object key
• options Object User input options;
  • options.Content-Length Object multipart content length
  • options.Content-MD5 Object multipart content MD5sum
  • options.X-QS-Copy-Range Specify range of the source object
  • options.X-QS-Copy-Source Copy source, format (//)
  • options.X-QS-Copy-Source-Encryption-Customer-Algorithm Encryption algorithm of the object
  • options.X-QS-Copy-Source-Encryption-Customer-Key Encryption key of the object
  • options.X-QS-Copy-Source-Encryption-Customer-Key-MD5 MD5sum of encryption key
  • options.X-QS-Copy-Source-If-Match Check whether the Etag of copy source matches the specified value
  • options.X-QS-Copy-Source-If-Modified-Since Check whether the copy source has been modified since the specified date
  • options.X-QS-Copy-Source-If-None-Match Check whether the Etag of copy source does not matches the specified value
  • options.X-QS-Copy-Source-If-Unmodified-Since Check whether the copy source has not been unmodified since the specified date
  • options.X-QS-Encryption-Customer-Algorithm Encryption algorithm of the object
  • options.X-QS-Encryption-Customer-Key Encryption key of the object
  • options.X-QS-Encryption-Customer-Key-MD5 MD5sum of encryption key
  • options.part_number Object multipart upload part number
  • options.upload_id Object multipart upload ID

Returns Promise axios response

QingStor

QingStor Module

Parameters

• config Object object

listBuckets

Retrieve the bucket list. Documentation URL

Parameters

• options Object User input options;
  • options.Location Limits results to buckets that in the location
  • options.limit Results count limit
  • options.offset Limit results to keys that start at this offset

Returns Promise axios response