new cloudServers(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
addServer(body)
Create a new server
Parameters:
| Name |
Type |
Description |
body |
ServerCreate
|
server details |
- Source:
console(serverId)
Get a console URL to this server
Parameters:
| Name |
Type |
Description |
serverId |
string
|
Server to access (serverId) |
- Source:
destroyServer(serverId)
Destroy an existing server
Parameters:
| Name |
Type |
Description |
serverId |
string
|
Id of server to be destroyed |
- Source:
getServerActionById(serverId, serverActionId)
Get ServerAction by id
Parameters:
| Name |
Type |
Description |
serverId |
string
|
serverId of associated server |
serverActionId |
string
|
Id of ServerAction to be fetched |
- Source:
getServerActionList(serverId, type, limit, offset)
List of actions performed on the specified server
Parameters:
| Name |
Type |
Description |
serverId |
string
|
serverId of associated server |
type |
string
|
Action type filter (exact match) |
limit |
integer
|
Number of results to display |
offset |
integer
|
The starting position of the query |
- Source:
getServerAddressById(serverId, addressId)
Find Addresses by serverId and addressId
Parameters:
| Name |
Type |
Description |
serverId |
string
|
serverId of associated server |
addressId |
string
|
Id of Address to be fetched |
- Source:
getServerAddressList(serverId, address, status, type, limit, offset)
List of Addresses of the specified server
Parameters:
| Name |
Type |
Description |
serverId |
string
|
serverId of associated server |
address |
string
|
Numeric address (exact match) |
status |
string
|
Address status (exact match) |
type |
string
|
Address type (exact match) |
limit |
integer
|
Number of results to display |
offset |
integer
|
The starting position of the query |
- Source:
getServerById(serverId)
Find server by serverId
Parameters:
| Name |
Type |
Description |
serverId |
string
|
Id of server to be fetched |
- Source:
getServerList(status, backupsEnabled, limit, offset)
Get a list of servers. By default, all destroyed servers are filtered out.
Parameters:
| Name |
Type |
Description |
status |
string
|
Server status filter (exact match) |
backupsEnabled |
boolean
|
BackupsEnabled flag |
limit |
integer
|
Number of results to display |
offset |
integer
|
The starting position of the query |
- Source:
getServerVolumeById(serverId, volumeId)
Find volume by serverId and volumeId
Parameters:
| Name |
Type |
Description |
serverId |
string
|
serverId of associated server |
volumeId |
string
|
Id of volume to be fetched |
- Source:
getServerVolumeList(serverId, zoneId, status, volumeSpecId, limit, offset)
Get a list of volumes for server
Parameters:
| Name |
Type |
Description |
serverId |
string
|
serverId filter |
zoneId |
string
|
zoneId filter |
status |
string
|
Volume status (exact match) |
volumeSpecId |
integer
|
Filter by the volume spec id |
limit |
integer
|
Number of results to display |
offset |
integer
|
The starting position of the query |
- Source:
patchServer(serverId, body)
Update server details
Parameters:
| Name |
Type |
Description |
serverId |
string
|
serverId of server to be updated |
body |
Server
|
Server data |
- 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:
startServer(serverId)
Start a server
Parameters:
| Name |
Type |
Description |
serverId |
string
|
serverId of server to be started |
- Source:
stopServer(serverId)
Stop a server
Parameters:
| Name |
Type |
Description |
serverId |
string
|
serverId of server to be stopped |
- Source: