new cloudDataCenters(domainOrOptionsopt)
Parameters:
| Name |
Type |
Attributes |
Description |
domainOrOptions |
string
|
object
|
<optional>
|
The project domain or options object. If object, see the object's optional properties.
Properties
| Name |
Type |
Attributes |
Description |
domain |
string
|
<optional>
|
The project domain |
token |
object
|
<optional>
|
auth token - object with value property and optional headerOrQueryName and isQuery properties |
|
- Source:
Methods
getDataCenterById(dataCenterId)
Find data center by dataCenterId
Parameters:
| Name |
Type |
Description |
dataCenterId |
string
|
Id of data center to be fetched |
- Source:
getDataCenterList(name, region, status, limit, offset)
Get a list of data centers
Parameters:
| Name |
Type |
Description |
name |
string
|
Data center name filter (exact match) |
region |
string
|
Region the data center is in (exact match) |
status |
string
|
Data center status filter (exact match) |
limit |
integer
|
Number of results to display |
offset |
integer
|
The starting position of the query |
- Source:
getDataCenterZoneList(dataCenterId, status, limit, offset)
List of zones in data center
Parameters:
| Name |
Type |
Description |
dataCenterId |
string
|
Retrieve all zones for a given data center |
status |
string
|
Retrieve all zones with this status |
limit |
integer
|
Number of results to display |
offset |
integer
|
The starting position of the query |
- Source:
getZoneById(dataCenterId, zoneId)
Get Zone by id
Parameters:
| Name |
Type |
Description |
dataCenterId |
string
|
Id of parent Data Center |
zoneId |
string
|
Id of Zone to be fetched |
- Source:
setToken(value, headerOrQueryName, isQuery)
Set Token
Parameters:
| Name |
Type |
Description |
value |
string
|
token's value |
headerOrQueryName |
string
|
the header or query name to send the token at |
isQuery |
boolean
|
true if send the token as query param, otherwise, send as header param |
- Source: