Home Reference Source
import {CloudlinkApi} from 's9s-cloudlink-api/src/CloudlinkApi.js'
public class | source

CloudlinkApi

CloudlinkApi class

Static Member Summary

Static Public Members
public static get

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

addInstance(names: Array, region: string, image: string, size: string, sshKey: string): Promise

Adds a new instance (Virtual machine)

public

addKey(name: string, publicKey: string): Promise

Registers a new public key on cloud provider

public

addSubNet(cidr: *, vpcId: *): Promise

Creates a new subnet within a VPC

public

addVpc(cidr: *, tenancy: *): Promise

Creates a new VPC (Virtual private network)

public

Deletes a key from cloud provider

public

Returns the status of an instance (Virtual machine)

public

listDistributions(filters: {}): Promise

Returns a list of distributions available on cloud provider

public

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

listVpcs(filters: {}, ids: Array): Promise

Returns a list of VPCs (Virtual private network)

Static Public Members

public static get supportedClouds: string[]: * source

A list of supported cloud (Cloud providers) codes

Return:

string[]

Public Constructors

public constructor(config: {}) source

CloudlinkApi constructor

Params:

NameTypeAttributeDescription
config {}

Configurations object (must include "auth" and "server" properties)

Throw:

CloudlinkApiError

Public Members

public config: * source

Public Methods

public addInstance(names: Array, region: string, image: string, size: string, sshKey: string): Promise source

Adds a new instance (Virtual machine)

Params:

NameTypeAttributeDescription
names Array

New instance/s names

region string

Region to create the instance/s at

image string

Image/ami to create the instance/s from

size string

Diskspace size

sshKey string

SSH key to deploy to the new instance/s

Return:

Promise

public addKey(name: string, publicKey: string): Promise source

Registers a new public key on cloud provider

Params:

NameTypeAttributeDescription
name string

Name of the new key

publicKey string

Public key contents

Return:

Promise

public addSubNet(cidr: *, vpcId: *): Promise source

Creates a new subnet within a VPC

Params:

NameTypeAttributeDescription
cidr *

CIDR block, network range

vpcId *

VPC id

Return:

Promise

public addVpc(cidr: *, tenancy: *): Promise source

Creates a new VPC (Virtual private network)

Params:

NameTypeAttributeDescription
cidr *

CIDR block, network range

tenancy *

Tenancy default/dedicated/host

Return:

Promise

public deleteKey(id: string | number): Promise source

Deletes a key from cloud provider

Params:

NameTypeAttributeDescription
id string | number

Key name/id

Return:

Promise

public getInstanceStatus(instanceId: string | number): Promise source

Returns the status of an instance (Virtual machine)

Params:

NameTypeAttributeDescription
instanceId string | number

The id of an instance

Return:

Promise

public listDistributions(filters: {}): Promise source

Returns a list of distributions available on cloud provider

Params:

NameTypeAttributeDescription
filters {}

Filters object

Return:

Promise

public listInstances(): Promise source

Returns a list of instances (Virtual machines)

Return:

Promise

public listKeys(): Promise source

Returns a list of SSH keys registered on cloud provider

Return:

Promise

public listRegions(): Promise source

Returns a list of regions available on cloud provider

Return:

Promise

public listSizes(): Promise source

Returns a list of sizes available on cloud provider

Return:

Promise

public listSubNets(): Promise source

Returns a list of subnets

Return:

Promise

public listVolumes(): Promise source

Returns a list of volumes (Virtual/disks)

Return:

Promise

public listVpcs(filters: {}, ids: Array): Promise source

Returns a list of VPCs (Virtual private network)

Params:

NameTypeAttributeDescription
filters {}

Filters object

ids Array

Ids list

Return:

Promise