API DocumentationStats
Retrieve VPC public traffic stats history
Get history VPC stats in given time span, or for given range (start -> end); in which case
the given timespan will be applied if data is available in given range.
Public here means the traffic going in and out of the VPC, not the internal traffic inside of it (for example between two virtual machines in same VPC). This is the traffic that the user will be billed for.
Notes :
- sometimes the reply might be delayed for few seconds, this will happen if you request was sent while new stats are being written.
Authorization
bearer_auth AuthorizationBearer <token>
Authentication
Create an API token on Profile, or with osctl auth login. Send it in the Authorization header:
Authorization: Bearer os1_...Do not use the Keycloak web-session JWT as an API token. Keep the secret secure and do not share it.
In: header
Path Parameters
vpc_id*string
A unique identifier for a VPC instance. See VPCs section for more details.
Format
uuidQuery Parameters
timespan?integer
time range to get stats from (in seconds):
- 10 minutes
- 1 hour
- 1 day
- 1 week
- 1 month (31 days)
- 1 year (366 days) if omitted, will send live stats (use this for testing only, not for production)
Value in
- 600
- 3600
- 86400
- 604800
- 2678400
- 31622400
start?integer
unix timestamp of the first datapoint
end?integer
unix timestamp of the last datapoint
Response Body
application/json
application/json
text/pain
application/json
application/json
curl -X GET "https://example.com/v1/stats/vpcs/f47ac10b-58cc-4372-a567-0e02b2c3d479"{ "meta": { "step": 60, "start": 1672565200, "end": 1672565200, "rows": 120, "columns": 10, "legend": [ "rx", "tx" ] }, "data": [ [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ 0.7049415575770971, 0.6392863186500269 ], [ 0.7303810571095024, 0.17954750793147822 ], [ 0.44679365565810836, 0.018130894380722573 ], [ 0.235376433423779, 0.9017556874843077 ], [ 0.5682892587062257, 0.6438457963990755 ], [ 0.13921111504043304, 0.5868470677443638 ], [ 0.12592475776064738, 0.2713036064675072 ], [ 0.26942759840746033, 0.5506040759930019 ], [ 0.6660331896941745, 0.4929802417785062 ], [ 0.738536452576965, 0.31216641512284704 ], [ 0.5987954332789174, 0.3353681186346391 ], [ 0.780787152285007, 0.903556453434933 ], [ 0.5318503216448301, 0.43930514563006606 ], [ 0.453136176911774, 0.2719328695743377 ], [ 0.2866004540837481, 0.6710204734205634 ], [ 0.06425008743916583, 0.6699685039712432 ], [ 0.3005036748185608, 0.20380269913792626 ], [ 0.8493210881460133, 0.5583702360134536 ], [ 0.19759948615863998, 0.6655906966639173 ], [ 0.6438946855117494, 0.2025254579418092 ] ]}{ "errors": [ { "message": "'vcpus' field must be an integer", "field": "resource_id" } ]}"Access denied"{ "errors": [ { "message": "User not initialized. Send POST /v1/init, then retry the request." } ]}{ "errors": [ { "message": "VM with ID 23 not found" } ]}