CloudlinkApi
CloudlinkApi class
Static Member Summary
Static Public Members | ||
public static get |
supportedClouds: string[]: * A list of supported cloud (Cloud providers) codes |
Constructor Summary
Public Constructor | ||
public |
constructor(config: {}) CloudlinkApi constructor |
Member Summary
Public Members | ||
public |
config: * |
Method Summary
Public Methods | ||
public |
Adds a new instance (Virtual machine) |
|
public |
Registers a new public key on cloud provider |
|
public |
Creates a new subnet within a VPC |
|
public |
Creates a new VPC (Virtual private network) |
|
public |
Deletes a key from cloud provider |
|
public |
getInstanceStatus(instanceId: string | number): Promise Returns the status of an instance (Virtual machine) |
|
public |
listDistributions(filters: {}): Promise Returns a list of distributions available on cloud provider |
|
public |
listInstances(ids: Array): Promise Returns a list of instances (Virtual machines) |
|
public |
Returns a list of SSH keys registered on cloud provider |
|
public |
Returns a list of regions available on cloud provider |
|
public |
Returns a list of sizes available on cloud provider |
|
public |
Returns a list of subnets |
|
public |
Returns a list of volumes (Virtual/disks) |
|
public |
Returns a list of VPCs (Virtual private network) |
Static Public Members
Public Constructors
public constructor(config: {}) source
CloudlinkApi constructor
Params:
Name | Type | Attribute | Description |
config | {} | Configurations object (must include "auth" and "server" properties) |
Throw:
Public Members
public config: * source
Public Methods
public addInstance(names: Array, region: string, image: string, size: string, sshKeys: string): Promise source
Adds a new instance (Virtual machine)
public addKey(name: string, publicKey: string): Promise source
Registers a new public key on cloud provider
public addSubNet(cidr: *, vpcId: *): Promise source
Creates a new subnet within a VPC
Params:
Name | Type | Attribute | Description |
cidr | * | CIDR block, network range |
|
vpcId | * | VPC id |
public addVpc(cidr: *, tenancy: *): Promise source
Creates a new VPC (Virtual private network)
Params:
Name | Type | Attribute | Description |
cidr | * | CIDR block, network range |
|
tenancy | * | Tenancy default/dedicated/host |
public getInstanceStatus(instanceId: string | number): Promise source
Returns the status of an instance (Virtual machine)
public listDistributions(filters: {}): Promise source
Returns a list of distributions available on cloud provider
Params:
Name | Type | Attribute | Description |
filters | {} | Filters object |
public listInstances(ids: Array): Promise source
Returns a list of instances (Virtual machines)
Params:
Name | Type | Attribute | Description |
ids | Array |
|