external/HyperProxmox
1
0
Fork 0
mirror of https://github.com/ThomasGsp/HyperProxmox.git synced 2025-03-09 15:40:18 +00:00
Code Issues Releases Wiki Activity

Doc - api info

Browse source
This commit is contained in:
Tlams 2018-05-02 16:06:21 +01:00
parent afaf640f0e
commit bd03e894fd
2 changed files with 82 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

46
doc/md/07-api.md
View file

@ -1,15 +1,22 @@
# API Information
List of all API access available.
Examples are available in the next page.
### Instance status management
``` bash
'/api/v1/instance/id/<MongoID>/status/(start|stop|current|reset|shutdown)' | GET
'/api/v1/static/instances/<date>|last/<cluster>/<node>/<vmid>/(start|stop|current|reset|shutdown)' | GET
```
### Cluster management
``` bash
'/api/v1/administration/cluster/<cluster>' | GET - Return the informations for an specific cluster
| PUT - Update the configurations for an specific cluster
| DELETE - Delete the configuration for an specific cluster
| POST - Insert a new cluster
'/api/v1/administration/cluster' | GET - Return all clusters information
@ -26,30 +33,30 @@ This data are manage by the crawler, you can't insert or change data yourself
``` bash
# date/cluster/node/vmid
# Disks mapping
'/api/v1/static/disks/<date>/<cluster>/<node>/<vmid>' | GET - Return the informations for an specific disk
'/api/v1/static/disks/<date>/<cluster>/<node>/' | GET - Return all disks used in a node
'/api/v1/static/disks/<date>/<cluster>/' | GET - Return all disks used in a cluster
'/api/v1/static/disks/<date>/' | GET - Return all disks
'/api/v1/static/disks/<date>|last/<cluster>/<node>/<vmid>' | GET - Return the informations for an specific disk
'/api/v1/static/disks/<date>|last/<cluster>/<node>/' | GET - Return all disks used in a node
'/api/v1/static/disks/<date>|last/<cluster>/' | GET - Return all disks used in a cluster
'/api/v1/static/disks/<date>|last/' | GET - Return all disks
# Storages mapping
'/api/v1/static/storages/<date>/<cluster>/<node>/' | GET - Return all storage used in a node
'/api/v1/static/storages/<date>/<cluster>/' | GET - Return all storages used in a cluster
'/api/v1/static/storages/<date>/' | GET - Return all storages
'/api/v1/static/storages/<date>|last/<cluster>/<node>/' | GET - Return all storage used in a node
'/api/v1/static/storages/<date>|last/<cluster>/' | GET - Return all storages used in a cluster
'/api/v1/static/storages/<date>|last/' | GET - Return all storages
# Instances mapping
'/api/v1/static/instances/<date>/<cluster>/<node>/<vmid>' | GET - Return the informations for an specific instance
'/api/v1/static/instances/<date>/<cluster>/<node>/' | GET - Return all instances for a node
'/api/v1/static/instances/<date>/<cluster>/' | GET - Return all instances for a cluster
'/api/v1/static/instances/<date>/' | GET - Return all instances (the dump can be very big, in a large infrastructure)
'/api/v1/static/instances/<date>|last/<cluster>/<node>/<vmid>' | GET - Return the informations for an specific instance
'/api/v1/static/instances/<date>|last/<cluster>/<node>/' | GET - Return all instances for a node
'/api/v1/static/instances/<date>|last/<cluster>/' | GET - Return all instances for a cluster
'/api/v1/static/instances/<date>|last/' | GET - Return all instances (the dump can be very big, in a large infrastructure)
# Nodes mapping
'/api/v1/static/nodes/<date>/<cluster>/<node>' | GET - Return the informations for an specific node
'/api/v1/static/nodes/<date>/<cluster>/' | GET - Return all nodes for a cluster
'/api/v1/static/nodes/<date>/' | GET - Return all nodes
'/api/v1/static/nodes/<date>|last/<cluster>/<node>' | GET - Return the informations for an specific node
'/api/v1/static/nodes/<date>|last/<cluster>/' | GET - Return all nodes for a cluster
'/api/v1/static/nodes/<date>|last/' | GET - Return all nodes
# cluster mapping
'/api/v1/static/clusters/<date>/<cluster>' | GET - Return the insformations for a specific cluster
'/api/v1/static/clusters/<date>/' | GET - Return all cluster informations
'/api/v1/static/clusters/<date>|last/<cluster>' | GET - Return the insformations for a specific cluster
'/api/v1/static/clusters/<date>|last/' | GET - Return all cluster informations
# date
'/api/v1/static/dates/(all|last)' | GET - Return all or the last date available (generated by the crawler)
@ -57,12 +64,11 @@ This data are manage by the crawler, you can't insert or change data yourself
# mongoid
'/api/v1/static/(instances|nodes|clusters|storages|disks)/id/<MongoID>' | GET - Return an information by mongoid
```
### Typical use
``` bash
curl http://127.0.0.1:8080/api/v1/static/nodes/1519040226/Cluster_1/sd-817348
```
<something> = Change this value
<date>|last = Two way - Use specific timestamp or select automaticaly the last date
[Usage - logs](06-logs.md) <-- Previous | Next --> [Usage - General](08-usages.md)