Reference
One row per commitment
Every reservation or plan the tenant holds, one row each, with the state the cloud reports rather than one derived from the end date. A plan that starts next month is queued and one whose payment failed is neither running nor expired, and no date says either. Attributes only some services carry arrive as null rather than zero.
Authorization
BearerAuth In: header
Query Parameters
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/inventory?instrument=string"{
"success": true,
"timestamp": "2019-08-24T14:15:22Z",
"data": {
"provider": "string",
"instrument": "ri",
"rows": [
{
"id": "string",
"account_id": "string",
"account_name": "string",
"state": "active",
"payment_option": "string",
"start": "string",
"end": "string",
"end_is_derived": true,
"term_months": 0,
"currency": "string",
"arn": "string",
"tags": {
"property1": "string",
"property2": "string"
},
"product_description": "string",
"committed_monthly": 0,
"saved_monthly": 0,
"unused_monthly": 0,
"on_demand": {
"currency": "string",
"measured_from": "string",
"measured_to": "string",
"on_demand_cost": 0,
"covered_cost": 0,
"unit_hours": 0,
"daily_on_demand_cost": 0
},
"kind": "reserved_instance",
"service": "string",
"service_label": "string",
"resource": "string",
"qty": 0,
"region": "string",
"fixed_price": 0,
"recurring_hourly": 0,
"usage_hourly": 0,
"offering_class": "string",
"scope": "string",
"availability_zone": "string",
"tenancy": "string",
"multi_az": true,
"node_offering": "string",
"reservation_name": "string"
}
]
}
}{
"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"
}Effective savings rate, globally and per account GET
What the same usage would have cost at public on-demand rates against what it actually cost, for the organization and for each account that consumed the benefit. The rate is split into the part a negotiated agreement earns and the part commitments earn, because the public on-demand price sits above both and an account owning no commitment at all would otherwise report a healthy rate.
Get commitments overview GET
ESR strip and aggregate RI/SP metrics for the requested provider (AWS real, GCP/Azure return zeros).