Child pages
  • REST API for the Management of NDS Labs Environments

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This document defines the REST API implemented by nds-webservices to manage NDS Labs Environments.

 

ResourcesActivitiesParametersHTTP verb mappingReturn value
NDS Lab Environment


Create a NDS Lab Environment.
  1. user name
  2. password
  3. name of the cluster
  4. number of instances
  5. number of master nodes
  6. IP address(es) for all master node(s)
  7. image that instances spin on 
  8. size of volumes.
POST users/lab_environment/:lab_id

{

"success":true,

"lab_id":

{

"master1_ip":,

"master2_ip":

},

"ssh_key_url":

}

List all NDS Lab Environments GET users/lab_environment

 {

"success":true,

{

"lab_name":,

"lab_status":

{

"master1_ip":

"master2_ip":

}

"service1":

"service2:"

"owners":

 

}

 

}

Stop a NDS Lab Environment.
  1. user name
  2. password
  3. NDS Lab Environment ID
PUT users/lab_environment/:lab_id/status 
Destroy a NDS Lab Environment.
  1. user name
  2. password
  3. NDS Lab Environment ID
DELETE users/lab_environment/:lab_id

 {

"success":true

}