API Docs for: 0.7.0
Show:

API.OSS Class

Defined in: lib/api.js:13
Module: API

API manipulation class

Constructor

API.OSS

()

Defined in lib/api.js:13

Methods

copyObject

(
  • headers
  • source
  • bucket
  • object
  • callback
)

Defined in lib/api.js:169

Copy object

Parameters:

  • headers Object

    http header 请求 Header:
    x-oss-copy-source复制源地址(必须有可读权限)
    x-oss-copy-source-if-match如果源Object的ETAG值和用户提供的ETAG相等,则执行拷贝操作; 否则返回412HTTP错误码(预处理失败)。
    x-oss-copy-source-if-nonematch如果源Object自从用户指定的时间以后就没有被修改过, 则执行拷贝操作;否则返回412HTTP36错误码(预处理失败)。
    x-oss-copy-source-if-unmodified-since如果传入参数中的时间等于或者晚于文件实际修改时间, 则正常传输文件,并返回200OK;否则返回412preconditionfailed错误
    x-oss-copy-source-if-modified-since如果源Object自从用户指定的时间以后被修改过, 则执行拷贝操作;否则返回412HTTP错误码(预处理失败)。
    x-oss-metadata-directive有效值为COPY和REPLACE。如果该值设为COPY, 则新的Object的meta都从源Object复制过来;如果设为REPLACE,则忽视所有源Object的meta值, 而采用用户这次请求中指定的meta值;其他值则返回400HTTP错误码。

  • source String

    x-oss-copy-source value

  • bucket String

    bucket name

  • object String

    object name

  • callback Function

    Called when OSS response, supplied with http.Response object.

deleteBucket

(
  • bucket
  • callback
)

Defined in lib/api.js:104

Delete bucket

Parameters:

  • bucket String

    Bucket name

  • callback Function

    Called when OSS response, supplied with http.Response object.

deleteMultipleObject

(
  • bucket
  • object
  • isQuite
  • callback
)

Defined in lib/api.js:227

Delete mutiple object at one time

Parameters:

  • bucket String

    bucket name

  • object Array

    List of object names need to be deleted

  • isQuite Bool

    verbose or quite mode in response

  • callback Function

    Called when OSS response, supplied with http.Response object.

deleteObject

(
  • bucket
  • object
  • callback
)

Defined in lib/api.js:213

Delete object

Parameters:

  • bucket String

    bucket name

  • object String

    object name

  • callback Function

    Called when OSS response, supplied with http.Response object.

deleteObjectGroup

(
  • bucket
  • group
  • callback
)

Defined in lib/api.js:322

Delete object group

Parameters:

  • bucket String

    bucket name

  • group String

    group name

  • callback Function

    Called when OSS response, supplied with http.Response object.

getBucket

(
  • bucket
  • queryObj
  • callback
)

Defined in lib/api.js:71

Get bucket information,list objects in bucket

Parameters:

  • bucket String

    bucket name

  • queryObj Object

    Query parameters,can be three of the following

    • prefix
    • marker
    • delimiter
    • max-keys

  • callback Function

    Called when OSS response, supplied with http.Response object.

getBucketACL

(
  • bucket
  • callback
)

Defined in lib/api.js:91

Get bucket's ACL info

Parameters:

  • bucket String

    Bucket name

  • callback Function

    Called when OSS response, supplied with http.Response object.

getObject

(
  • headers
  • queryObj
  • bucket
  • object
  • callback
)

Defined in lib/api.js:134

Get object data

Parameters:

  • headers Object

    http headers,you should take care of Content-Length, and also support Cache-Control、Expires、Content-Encoding、Content-Disposition

  • queryObj Object

    Extra query string in object format
    请求 Header:
    Range 指定文件传输的范围。如,设定 bytes=0-9,表示传送第 0 到第 9 这 10 个字符。
    If-Modified-Since 如果指定的时间早于实际修改时间,则正常传送文件,并返回 200 OK; 否则返回 304 not modified
    If-Unmodified-Since 如果传入参数中的时间等于或者晚于文件实际修改时间,则正常传输文件, 并返回 200 OK;否则返回 412 precondition failed 错误 If-Match 如果传入期望的 ETag 和 object 的 ETag 匹配,则正常传输文件,并返回 200 OK; 否则返回 412 precondition failed 错误
    If-None-Match 如果传入的 ETag 值和 Object 的 ETag 不匹配,则正常传输文件,并返回 200 OK; 否则返回 304 Not Modified
    请求参数:
    OSS支持用户在发送GET请求时,可以自定义OSS返回请求中的一些Header,这些 Header 包括:
    response-content-type 设置 OSS 返回请求的 content-type 头
    response-content-language 设置 OSS 返回请求的 content-language 头
    response-expires 设置 OSS 返回请求的 expires 头
    response-cache-control 设置 OSS 返回请求的 cache-control 头
    response-content-disposition 设置OSS返回请求的content-disposition头
    response-content-encoding 设置 OSS 返回请求的 content-encoding 头

  • bucket String

    bucket name

  • object String

    object name

  • callback Function

    Called when OSS response, supplied with http.Response object.

getObjectGroup

(
  • bucket
  • group
  • headers
  • callback
)

Defined in lib/api.js:279

Get object group Content

Parameters:

  • bucket String

    bucket name

  • group String

    group name

  • headers Object

    Can add 'Range' in here.And it's optional

  • callback Function

    Called when OSS response, supplied with http.Response object.

getObjectGroupIndex

(
  • bucket
  • group
  • callback
)

Defined in lib/api.js:294

Get object object's info in group

Parameters:

  • bucket String

    bucket name

  • group String

    group name

  • callback Function

    Called when OSS response, supplied with http.Response object.

getService

(
  • callback
)

Defined in lib/api.js:22

GET OSS ListBucket Service

Parameters:

  • callback Function

    Called when OSS response, supplied with http.Response object

headObject

(
  • bucket
  • object
  • callback
)

Defined in lib/api.js:199

Get object meta info

Parameters:

  • bucket String

    bucket name

  • object String

    object name

  • callback Function

    Called when OSS response, supplied with http.Response object.

headObjectGroup

(
  • bucket
  • group
  • callback
)

Defined in lib/api.js:308

Get group info

Parameters:

  • bucket String

    bucket name

  • group String

    group name

  • callback Function

    Called when OSS response, supplied with http.Response object.

postObjectGroup

(
  • bucket
  • group
  • parts
  • callback
)

Defined in lib/api.js:255

Create new object group

Parameters:

  • bucket String

    bucket name

  • group String

    group name

  • parts Array

    Supply object info,With the following format {'PartNumber': 1,'PartName': 'stuff','ETag': 686897696a7c876b7e}
    Because of this,you have to first fetch ETag of each object you want to join in group

  • callback Function

    Called when OSS response, supplied with http.Response object.

putBucket

(
  • bucket
  • callback
)

Defined in lib/api.js:34

Add Or Modify bucket

Parameters:

  • bucket String

    bucket name

  • callback Function

    Called when OSS response, supplied with http.Response object.

putBucket

(
  • bucket
  • acl
  • callback
)

Defined in lib/api.js:47

Add Or Modify bucket with o-oss-acl header

Parameters:

  • bucket String

    bucket name

  • acl String

    access control.Can be following three value:

    • private
    • public-read
    • public-read-write

  • callback Function

    Called when OSS response, supplied with http.Response object.

putObject

(
  • headers
  • bucket
  • object
  • data
  • callback
)

Defined in lib/api.js:117

Add Or Update an object

Parameters:

  • headers Object

    http headers,you should take care of Content-Length, and also support Cache-Control、Expires、Content-Encoding、Content-Disposition

  • bucket String

    bucket name

  • object String

    object name

  • data String

    object content

  • callback Function

    Called when OSS response, supplied with http.Response object.