Compute API - leoswaldo/ciao GitHub Wiki
CIAO's Compute API
This documentation is Work In Progress effort
Below you will find the definition for CIAO's Compute API requests
Versions
| Method | Request | Action | Status |
|---|---|---|---|
| GET | / | List API Versions | Not Implemented |
| GET | /v2.1 | Show API v2.1 | Not Implemented |
| POST | /v2 | Show API v2 | Not Implemented |
Servers
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/β{tenant}β/servers | List Servers | Not Implemented |
| POST | /v2.1/{tenant}/servers | Create Server | Done |
| GET | /v2.1/{tenant}/servers/detail | List Servers | Done |
| GET | /v2.1/{tenant}/servers/{server} | Show Server Details | Done |
| DELETE | /v2.1/{tenant}/servers/{server} | Delete Server | Done |
| PUT | /v2.1/β{tenant}β/servers/β{server} | Update Server | Not Implementedβ |
| POST | /v2.1/{tenant}/servers/action | Tenant Server Action | Done |
Servers Action
| Method | Request | Server Action | Status |
|---|---|---|---|
| POST | /v2.1/{tenant}/servers/{server}/action | Start server (os-start action) | Done |
| POST | /v2.1/{tenant}/servers/{server}/action | Stop server (os-stop action) | Done |
| POST | /v2.1/{tenant}/servers/{server}/action | Delete server (os-delete action) | Done |
| POST | /v2.1/{tenant}/servers/{server}/action | Reboot server (reboot action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Add (associate) fixed IP (addFixedIp action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Add (associate) floating IP (addFloatingIp action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Change administrative password | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Confirm resized server (confirmResize action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Create image (createImage action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Evacuate server (evacuate action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Force-delete server (forceDelete action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Lock server (lock action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Pause server (pause action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Show console output (os-getConsoleOutput action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Get RDP console (os-getRDPConsole action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Get serial console (os-getSerialConsole action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Get SPICE console (os-getSPICEConsole action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Get VNC console (os-getVNCConsole action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Rebuild server (rebuild action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Remove (disassociate) fixed IP (removeFixedIp action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Remove (disassociate) floating IP (removeFloatingIp action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Rescue server (rescue action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Resize server (resize action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Restore soft-deleted instance (restore action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Resume suspended server (resume action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Revert resized server (revertResize action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Shelve server (shelve action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Shelf-offload (remove) server (shelveOffload action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Unlock server (unlock action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Unpause server (unpause action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Unrescue server (unrescue action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Unshelve (restore) shelved server (unshelve action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Add security group to a server (addSecurityGroup action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Remove security group from a server (removeSecurityGroup action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Trigger crash dump in server (trigger_crash_dump action) | Not Implemented |
Servers - Administrative actions
| Method | Request | Action | Status |
|---|---|---|---|
| POST | /v2.1/{tenant}/servers/{server}/action | Create server back up (createBackup action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Inject network information (injectNetworkInfo action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Migrate server (migrate action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Live-migrate server (os-migrateLive action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Reset networking on a server (resetNetwork action) | Not Implemented |
| POST | /v2.1/{tenant}/servers/{server}/action | Reset server state (os-resetState action) | Not Implemented |
Servers Diagnostics
| Method | Request | Action | Status |
|---|---|---|---|
| POST | /v2.1/β{tenant}β/servers/β{server}β/diagnostics | Show server diagnostics | Not Implemented |
Servers IPs
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/β{tenant}β/servers/β{server}β/ips | List IPs | Not Implemented |
| GET | /v2.1/β{tenant}β/servers/β{server}β/ips/β{network_label}β | Show IP details | Not Implemented |
Server metadata
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/β{tenant}β/servers/β{server}β/metadata | List all metadata | Not Implemented |
| PUT | /v2.1/β{tenant}β/servers/β{server}β/metadata | Create or replace metadata items | Not Implemented |
| POST | /v2.1/β{tenant}β/servers/β{server}β/metadata | Update metadata items | Not Implemented |
| GET | /v2.1/β{tenant}β/servers/β{server}β/metadata/β{key}β | Show metadata item details | Not Implemented |
| PUT | /v2.1/β{tenant}β/servers/β{server}β/metadata/β{key}β | Create or update metadata item | Not Implemented |
| DELETE | /v2.1/β{tenant}β/servers/β{server}β/metadata/β{key}β | Delete metadata item | Not Implemented |
Server os-instance-actions
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/β{tenant}β/servers/β{server}β/os-instance-actions | List actions for server | Not Implemented |
| GET | /v2.1/β{tenant}β/servers/β{server}β/os-instance-actions/β{request}β | Show server action details | Not Implemented |
Server Port Interfaces
| Method | Request | Action | Status |
|---|---|---|---|
| POST | /v2.1/β{tenant}β/servers/β{server}β/os-interface | Create interface | Not Implemented |
| GET | /v2.1/β{tenant}β/servers/β{server}β/os-interface | List port interfaces | Not Implemented |
| GET | /v2.1/β{tenant}β/servers/β{server}β/os-interface/β{port_id}β | Show port interface details | Not Implemented |
| DELETE | /v2.1/β{tenant}β/servers/β{server}β/os-interface/β{port_id}β | Detach interface | Not Implemented |
Servers Password
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/β{tenant}β/servers/β{server}β/os-server-password | Show server password | Not Implemented |
| DELETE | /v2.1/β{tenant}β/servers/β{server}β/os-server-password | Clear admin password | Not Implemented |
Servers virtual interfaces
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/β{tenant}β/servers/β{server}β/os-virtual-interfaces | List virtual interfaces | Not Implemented |
Servers with Volume Attachments
| Method | Request | Action | Status |
|---|---|---|---|
| POST | /v2.1/β{tenant}β/servers/β{server}β/os-volume_attachments | Attach volume to server | Not Implemented |
| GET | /v2.1/β{tenant}β/servers/β{server}β/os-volume_attachments | List volume attachments | Not Implemented |
| GET | /v2.1/β{tenant}β/servers/β{server}β/os-volume_attachments | Show volume attachment details | Not Implemented |
| DELETE | /v2.1/β{tenant}β/servers/β{server}β/os-volume_attachments | Detach volume | Not Implemented |
Flavors
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/{tenant}/flavors | List Flavors | Done |
| POST | /v2.1/β{tenant}β/flavors | Create flavor | Not Implemented |
| GET | /v2.1/{tenant}/flavors/detail | List Flavors Details | Done |
| GET | /v2.1/{tenant}/flavors/{flavor} | Show Flavor Details | Done |
| GET | /v2.1/flavors/{flavor}/servers/detail | List Servers Detail of Flavor | Done |
| DELETE | /v2.1/β{tenant}β/flavors/β{flavor}β | Delete flavor | Not Implemented |
Flavors access
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/β{tenant}β/flavors/os-flavor-access | List flavor access information for given flavor | Not Implemented |
| POST | /v2.1/β{tenant}β/flavors/os-flavor-access/β{flavor}β/action | Add flavor access to tenant | Not Implemented |
| POST | /v2.1/β{tenant}β/flavors/os-flavor-access/β{flavor}β/action | Remove flavor access from tenant | Not Implemented |
Flavors extra-specs
| Method | Request | Action | Status |
|---|---|---|---|
| POST | /v2.1/β{tenant}β/flavors/β{flavor}β/os-extra_specs | Create extra specs for a flavor | Not Implemented |
| GET | /v2.1/β{tenant}β/flavors/β{flavor}β/os-extra_specs | List extra specs for a flavor | Not Implemented |
| GET | /v2.1/β{tenant}β/flavors/β{flavor}β/os-extra_specs/β{flavor_extra_spec_key}β | Show an extra spec for a flavor | Not Implemented |
| PUT | /v2.1/β{tenant}β/flavors/β{flavor}β/os-extra_specs/β{flavor_extra_spec_key}β | Update an extra spec for a flavor | Not Implemented |
| DELETE | /v2.1/β{tenant}β/flavors/β{flavor}β/os-extra_specs/β{flavor_extra_spec_key}β | Delete an extra spec for a flavor | Not Implemented |
Keypairs
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/β{tenant}β/os-keypairs | List keypairs | Not Implemented |
| POST | /v2.1/β{tenant}β/os-keypairs | Create or import keypair | Not Implemented |
| DELETE | /v2.1/β{tenant}β/os-keypairs/β{keypair_name}β | Delete keypair | Not Implemented |
| GET | /v2.1/β{tenant}β/os-keypairs/β{keypair_name}β | Show keypair details | Not Implemented |
Limits
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/β{tenant}β/limits | Show rate and absolute limits | Not Implemented |
Extensions
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/β{tenant}β/extensions | List extensions | Not Implemented |
| GET | /v2.1/β{tenant}β/extensions/β{alias}β | Show extension details | Not Implemented |
Images
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/β{tenant}β/images | List images | Not Implemented |
| GET | /v2.1/β{tenant}β/images/detail | List images details | Not Implemented |
| GET | /v2.1/β{tenant}β/images/β{image}β | Show image details | Not Implemented |
| DELETE | /v2.1/β{tenant}β/images/β{image}β | Delete image | Not Implemented |
Image Metadata
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/β{tenant}β/images/β{image}β/metadata | Show image metadata | Not Implemented |
| PUT | /v2.1/β{tenant}β/images/β{image}β/metadata | Create or replace image metadata | Not Implemented |
| POST | /v2.1/β{tenant}β/images/β{image}β/metadata | Update image metadata items | Not Implemented |
| GET | /v2.1/β{tenant}β/images/β{image}β/metadata/β{key}β | Show image metadata item details | Not Implemented |
| PUT | /v2.1/β{tenant}β/images/β{image}β/metadata/β{key}β | Create or update image metadata item | Not Implemented |
| DELETE | /v2.1/β{tenant}β/images/β{image}β/metadata/β{key}β | Delete image metadata item | Not Implemented |
Guest Agents
| Method | Request | Action | Status |
|---|---|---|---|
| POST | /v2.1/β{tenant}β/os-agents | Create agent build | Not Implemented |
| GET | /v2.1/β{tenant}β/os-agents | List agent builds | Not Implemented |
| DELETE | /v2.1/β{tenant}β/os-agents | Delete agent build | Not Implemented |
| PUT | /v2.1/β{tenant}β/os-agents/β{agent_build}β | Update agent build | Not Implemented |
Host Aggregates
| Method | Request | Action | Status |
|---|---|---|---|
| POST | /v2.1/β{tenant}β/os-aggregates | Create aggregate | Not Implemented |
| GET | /v2.1/β{tenant}β/os-aggregates | List aggregates | Not Implemented |
| GET | /v2.1/β{tenant}β/os-aggregates/β{aggregate}β | Show aggregate details | Not Implemented |
| DELETE | /v2.1/β{tenant}β/os-aggregates/β{aggregate}β | Delete aggregate | Not Implemented |
| PUT | /v2.1/β{tenant}β/os-aggregates/β{aggregate}β | Update aggregate | Not Implemented |
| POST | /v2.1/β{tenant}β/os-aggregates/β{aggregate}β/action | Add host | Not Implemented |
| POST | /v2.1/β{tenant}β/os-aggregates/β{aggregate}β/action | Create or update aggregate metadata | Not Implemented |
| POST | /v2.1/β{tenant}β/os-aggregates/β{aggregate}β/action | Remove host | Not Implemented |
Assisted Volume Snapshots
| Method | Request | Action | Status |
|---|---|---|---|
| POST | /v2.1/β{tenant}β/os-assisted-volume-snapshots | Create assisted volume snapshots | Not Implemented |
| DELETE | /v2.1/β{tenant}β/os-assisted-volume-snapshots/β{snapshot}β | Delete assisted volume snapshot | Not Implemented |
Availability Zones
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/β{tenant}β/os-availability-zone | Get availability zone information | Not Implemented |
| GET | /v2.1/β{tenant}β/os-availability-zone/detail | Get detailed availability zone information | Not Implemented |
Nodes
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/nodes | List Nodes | Done |
| GET | /v2.1/nodes/summary | List Nodes Summary | Done |
| GET | /v2.1/nodes/{node}/servers/detail | List Servers in Node | Done |
Bare Metal Nodes
| Method | Request | Action | Status |
|---|---|---|---|
| POST | /v2.1/β{tenant}β/servers/β{server}β/os-baremetal-nodes | Add bare metal node | Not Implemented |
| GET | /v2.1/β{tenant}β/servers/β{server}β/os-baremetal-nodes | List bare metal nodes | Not Implemented |
| POST | /v2.1/β{tenant}β/servers/β{server}β/os-baremetal-nodes/action | Add interface to bare metal node | Not Implemented |
| POST | /v2.1/β{tenant}β/servers/β{server}β/os-baremetal-nodes/action | Delete interface from bare metal node | Not Implemented |
| GET | /v2.1/β{tenant}β/servers/β{server}β/os-baremetal-nodes/β{node}β | Show bare metal node details | Not Implemented |
| DELETE | /v2.1/β{tenant}β/servers/β{server}β/os-baremetal-nodes/β{node}β | Delete bare metal node | Not Implemented |
Cells
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/β{tenant}β/os-cells | List cells | Not Implemented |
| GET | /v2.1/β{tenant}β/os-cells | List cells with details | Not Implemented |
| GET | /v2.1/β{tenant}β/os-cells/β{cell}β | Show cell data | Not Implemented |
| GET | /v2.1/β{tenant}β/os-cells/β{cell}β/capacities | Show cell capacities | Not Implemented |
Root Certificates
| Method | Request | Action | Status |
|---|---|---|---|
| POST | /v2.1/β{tenant_id}β/os-certificates | Create certificate | Not Implemented |
| GET | /v2.1/β{tenant_id}β/os-certificates/β{certificate_id}β | Show certificate details | Not Implemented |
Cloudpipe
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/β{tenant_id}β/os-cloudpipe | List cloudpipes | Not Implemented |
| POST | /v2.1/β{tenant_id}β/os-cloudpipe | Create cloudpipe | Not Implemented |
| POST | /v2.1/β{tenant_id}β/os-cloudpipe/configure-project | Update cloudpipe | Not Implemented |
CNCIs
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/cncis | List CNCIs | Done |
| GET | /v2.1/cncis/{cnci}/detail | List CNCI detail | Done |
Events
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/events | List Events | Done |
| DELETE | /v2.1/events | Clear Events | Done |
| GET | /v2.1/{tenant}/events" | List Event of a Tenant | Done |
Traces
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/traces | List Traces | Done |
| GET | /v2.1/traces/{label} | Trace Data | Done |
Tenants
| Method | Request | Action | Status |
|---|---|---|---|
| GET | /v2.1/tenants | List Tenants | Done |
| GET | /v2.1/{tenant}/quotas | List Tenant Quotas | Done |
| GET | /v2.1/{tenant}/resources | List Tenant Resources | Done |