IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

AccountAccessKey Property

A storage service provider access key.

Syntax

 cloudstorage.getAccountAccessKey([callback])
 cloudstorage.setAccountAccessKey( accountAccessKey, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getAccountAccessKey([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setAccountAccessKey([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

A storage service provider access key.

This property specifies the access key to use for authentication. It must be populated when using one of these storage service providers:

  • spAmazonS3 (0)
  • spAzureBlob (6)
  • spWasabi (7)
  • spDigitalOcean (8)
  • spGoogleStorage (9) (only if Authorization and AccountProjectId are not populated)
  • spAzureFile (11)
  • spIBMStorage (13)
  • spLinode (14)

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Node.js Edition - Version 20.0 [Build 8265]