Region Property
The region the class will make requests against.
Syntax
ibmstorage.getRegion([callback]) ibmstorage.setRegion( region, [callback])
Default Value
"us"
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 getRegion([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 setRegion([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
This property control which region the class will make requests against. By default the class uses us, the US cross region. This property should be changed to create or access resources in other regions.
Regions:
| Value | Region |
| Cross-Region | |
| us (default) | US Cross Region |
| dal.us | US Cross Region (Dallas Access Point) |
| sjc.us | US Cross Region (San Jose Access Point) |
| wdc.us | US Cross Region (Washington DC Access Point) |
| eu | EU Cross Region |
| ams.eu | EU Cross Region (Amsterdam Access Point) |
| fra.eu | EU Cross Region (Frankfurt Access Point) |
| mil.eu | EU Cross Region (Milan Access Point) |
| ap | Asia Pacific Cross Region |
| hkg.ap | Asia Pacific Cross Region (Hong Kong Access Point) |
| seo.ap | Asia Pacific Cross Region (Seoul Access Point) |
| tok.ap | Asia Pacific Cross Region (Tokyo Access Point) |
| Regional | |
| au-syd | Australia (Sydney) |
| eu-de | EU (Germany) |
| eu-gb | EU (United Kingdom) |
| jp-tok | Japan (Tokyo) |
| us-east | US (East) |
| us-south | US (South) |
| Single-Site | |
| ams03 | Netherlands (Amsterdam) |
| che01 | India (Chennai) |
| hkg02 | Hong Kong |
| mel01 | Australia (Melbourne) |
| mex01 | Mexico (Mexico City) |
| mil01 | Italy (Milan) |
| mon01 | Canada (Montreal) |
| osl01 | Norway (Oslo) |
| par01 | France (Paris) |
| sao01 | Brazil (Sao Paulo) |
| seo01 | South Korea (Seoul) |
| sjc04 | US (San Jose) |
| sng01 | Singapore |
| tor01 | Canada (Toronto) |
Note that private. or direct. may optionally be prepended to any of the values above; refer to IBM Cloud's Object Storage documentation for information on regions and endpoints.
The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value.
Data Type
String