Reference
Utilization for one instrument, optionally for one service
One entry per service for reservations, or per plan type for plans, each measured on its own and never rolled up: EC2 and RDS contract in vCPU while Redshift, ElastiCache, OpenSearch, Elasticsearch and MemoryDB contract in nodes, so an average across them describes neither. Each entry's headline divides the used hours by the purchased hours over the window rather than averaging its dimensions.
Authorization
BearerAuth AuthorizationBearer <token>
In: header
Query Parameters
provider?Provider
type?Type
start?|null
end?|null
granularity?Granularity
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/commitments/utilization"{
"success": true,
"timestamp": "2019-08-24T14:15:22Z",
"data": {
"instrument": "ri",
"services": [
{
"service": "string",
"service_label": "string",
"utilization_pct": 0,
"dimensions": [
{
"key": "capacity",
"used": 0,
"total": 0,
"unit": "string",
"utilization_pct": 0
}
],
"committed_monthly_usd": 0,
"committed_hourly_usd": 0,
"contracted_hourly_usd": 0,
"applied_to": [
{
"service": "string",
"hourly_usd": 0
}
],
"days": [
{
"date": "string",
"capacity_pct": 0,
"capacity_used": 0,
"capacity_total": 0,
"commitment_pct": 0,
"commitment_used_usd": 0,
"commitment_total_usd": 0,
"coverage_pct": 0
}
]
}
]
}
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}