gns3-server/docs/api/v2/controller/compute/sid.rst
2016-08-29 15:58:29 +02:00

6.6 KiB

/v2/computes/{compute_id}

PUT /v2/computes/{compute_id}

Get a compute server information

Response status codes

  • 200: Compute server updated
  • 400: Invalid request
  • 404: Instance doesn't exist

Input

Name Mandatory Type Description
compute_id string Server identifier
host string Server host
name string Server name
password ['string', 'null'] Password for authentication
port integer Server port
protocol enum Possible values: http, https
user ['string', 'null'] User for authentication

Output

Name Mandatory Type Description
capabilities object Get what a server support
compute_id string Server identifier
connected boolean Whether the controller is connected to the compute server or not
cpu_usage_percent ['number', 'null'] CPU usage of the compute. Read only
host string Server host
memory_usage_percent ['number', 'null'] RAM usage of the compute. Read only
name string Server name
port integer Server port
protocol enum Possible values: http, https
user ['string', 'null'] User for authentication

GET /v2/computes/{compute_id}

Get a compute server information

Response status codes

  • 200: Compute server information returned

Output

Name Mandatory Type Description
capabilities object Get what a server support
compute_id string Server identifier
connected boolean Whether the controller is connected to the compute server or not
cpu_usage_percent ['number', 'null'] CPU usage of the compute. Read only
host string Server host
memory_usage_percent ['number', 'null'] RAM usage of the compute. Read only
name string Server name
port integer Server port
protocol enum Possible values: http, https
user ['string', 'null'] User for authentication

DELETE /v2/computes/{compute_id}

Delete a compute instance

Parameters

  • compute_id: Compute UUID

Response status codes

  • 400: Invalid request
  • 404: Instance doesn't exist
  • 204: Instance deleted