import requests
url = "https://platform.ankra.app/api/v1/org/cloud-cost/objects/cluster/{cluster_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/org/cloud-cost/objects/cluster/{cluster_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/org/cloud-cost/objects/cluster/{cluster_id} \
--header 'Authorization: Bearer <token>'{
"kind": "cluster",
"object": {
"id": "<string>",
"name": "<string>",
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_name": "<string>"
},
"currency": "<string>",
"priced": true,
"unpriced_reason": "<string>",
"monthly_cents": 123,
"idle_pct": 123,
"share_of_fleet_pct": 123,
"confidence": "<string>",
"coverage_incomplete": true,
"open_waste": {
"available": true,
"reason": "<string>",
"count": 123,
"monthly_cents": 123,
"unpriced_count": 123,
"shared_not_counted_count": 123
},
"trend_30d": [
{
"date": "2023-12-25",
"cents": 123,
"partial": true,
"hours_metered": 12,
"hours_measured": 12,
"hours_estimated": 12,
"hours_missing": 12,
"incomplete": true,
"clusters_metered": 123,
"clusters_total": 123,
"fx_basis": "recorded"
}
],
"month_to_date_cents": 123,
"month_to_date_days_elapsed": 15,
"month_to_date_days_metered": 15,
"month_hours": {
"cluster_count": 123,
"hours_elapsed": 123,
"hours_estimated": 123,
"hours_measured": 123,
"hours_metered": 123,
"is_short": true,
"note": "<string>",
"short_cluster_count": 123
},
"clusters": [
{
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_name": "<string>",
"priced": true,
"monthly_cents": 123,
"confidence": "<string>",
"coverage_incomplete": true,
"price_list_as_of": "2023-12-25",
"price_source": "provider_list"
}
],
"namespaces": [
{
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_name": "<string>",
"namespace": "<string>",
"monthly_cents": 123,
"shared": true
}
],
"snapshot_stale_after_hours": 123,
"generated_at": "2023-11-07T05:31:56Z",
"change": {
"state": "explained",
"earlier_from": "<string>",
"earlier_to": "<string>",
"later_from": "<string>",
"later_to": "<string>",
"monthly_delta_cents": 123,
"causes": [
{
"kind": "scaled",
"environment_name": "<string>",
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_name": "<string>",
"namespace": "<string>",
"workload": "<string>",
"from_replicas": 123,
"to_replicas": 123,
"from_monthly_cents": 123,
"to_monthly_cents": 123,
"at": "2023-11-07T05:31:56Z",
"monthly_delta_cents": 123
}
],
"reason": "<string>"
},
"scope": {
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_name": "<string>",
"all_projects": true,
"partial": true
}
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "Cluster not found"
}Get a cluster's cost projection
What one cluster costs: its run rate at the latest snapshot inside the window, its idle share, its share of the fleet, its open waste and 30 days of daily cost. Bearer-PAT twin of the browser route of the same name under /org.
import requests
url = "https://platform.ankra.app/api/v1/org/cloud-cost/objects/cluster/{cluster_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/org/cloud-cost/objects/cluster/{cluster_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/org/cloud-cost/objects/cluster/{cluster_id} \
--header 'Authorization: Bearer <token>'{
"kind": "cluster",
"object": {
"id": "<string>",
"name": "<string>",
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_name": "<string>"
},
"currency": "<string>",
"priced": true,
"unpriced_reason": "<string>",
"monthly_cents": 123,
"idle_pct": 123,
"share_of_fleet_pct": 123,
"confidence": "<string>",
"coverage_incomplete": true,
"open_waste": {
"available": true,
"reason": "<string>",
"count": 123,
"monthly_cents": 123,
"unpriced_count": 123,
"shared_not_counted_count": 123
},
"trend_30d": [
{
"date": "2023-12-25",
"cents": 123,
"partial": true,
"hours_metered": 12,
"hours_measured": 12,
"hours_estimated": 12,
"hours_missing": 12,
"incomplete": true,
"clusters_metered": 123,
"clusters_total": 123,
"fx_basis": "recorded"
}
],
"month_to_date_cents": 123,
"month_to_date_days_elapsed": 15,
"month_to_date_days_metered": 15,
"month_hours": {
"cluster_count": 123,
"hours_elapsed": 123,
"hours_estimated": 123,
"hours_measured": 123,
"hours_metered": 123,
"is_short": true,
"note": "<string>",
"short_cluster_count": 123
},
"clusters": [
{
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_name": "<string>",
"priced": true,
"monthly_cents": 123,
"confidence": "<string>",
"coverage_incomplete": true,
"price_list_as_of": "2023-12-25",
"price_source": "provider_list"
}
],
"namespaces": [
{
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_name": "<string>",
"namespace": "<string>",
"monthly_cents": 123,
"shared": true
}
],
"snapshot_stale_after_hours": 123,
"generated_at": "2023-11-07T05:31:56Z",
"change": {
"state": "explained",
"earlier_from": "<string>",
"earlier_to": "<string>",
"later_from": "<string>",
"later_to": "<string>",
"monthly_delta_cents": 123,
"causes": [
{
"kind": "scaled",
"environment_name": "<string>",
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_name": "<string>",
"namespace": "<string>",
"workload": "<string>",
"from_replicas": 123,
"to_replicas": 123,
"from_monthly_cents": 123,
"to_monthly_cents": 123,
"at": "2023-11-07T05:31:56Z",
"monthly_delta_cents": 123
}
],
"reason": "<string>"
},
"scope": {
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_name": "<string>",
"all_projects": true,
"partial": true
}
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "Cluster not found"
}Authorizations
Response
Successful response
What one object of the organisation costs now, over the last 30 days and so far this month, read from the same snapshots and staleness window as the fleet summary. A cluster-based object (a cluster, a credential) costs its clusters' run rate, idle capacity included; a namespace-based object (a namespace, a stack, an application) costs its namespaces' allocations and has no idle share. Nothing unknown reads as zero. An application, a credential or a project is read on the clusters the caller may read only; scope.partial says when that left clusters out, so the figure is a floor of the object's.
monthly_cents over the fleet's run rate in the same window; null when either is unknown or the fleet is zero. The fleet is the organisation's, except for a token pinned to a project or a member limited to projects, whose fleet is that project's; either is cut to the clusters the caller may read when their cluster read is narrowed: exactly what their own fleet summary reads.
The object's daily spend over the last 30 UTC days, oldest first: the cents it cost each day, not a run rate like monthly_cents. The day the read falls in is still metering and is marked partial, so it is never comparable to a whole day. A project's days are what was metered under the project's stamp, whichever cluster was metered: a cluster that moved out or was deleted keeps its days here, a cluster that moved in brings none of its days under another project, and each day's clusters_total is the clusters behind the project that day.
Show child attributes
Show child attributes
What the object has spent in the UTC calendar month of trend_30d's last day, up to the read. Read over the whole month, so the 31st of a month has one even though trend_30d covers 30 days. Null when no hour of the month was metered: unknown, not zero. For a cluster, a namespace, a stack or an application it is the same hourly figures trend_30d's days sum, over every hour of the month metered so far (the day still metering included), summed unrounded and rounded once. For a credential it is the credential's by_credential figure in the fleet summary, over the fleet the reader's share_of_fleet_pct divides by: the month of each metered cluster on it now, plus what a cluster deleted this month, or a live one whose metering stalled, spent under it. Spend on month rows written before the credential stamp existed is the provider's unattributed spend, in no credential's month, and a reader confined to a project reads the project's part of each cluster's month, as by_project does. A credential's month is therefore not the sum of trend_30d's days. For a project it is what was spent under the project's stamp this month, whichever cluster spent it: a cluster deleted this month, or moved to another project after spending under this one, keeps what it spent here, and a cluster that moved in brings none of what it spent before. It equals the project's by_project figure in the fleet summary. trend_30d's days read the same stamp, so a cluster's money is in both or in neither; the month prices an hour at its latest metering pass and a day at the mean of its passes, so the month is not the days added up to the cent.
How many of those days month_to_date_cents covers in full: an ended day on which every cluster behind the object was metered for all 24 hours, plus the day still metering, which counts as metered so far rather than as a gap. That day is not counted while the node inventory of a cluster behind the object is stale: nothing is metering that cluster, so what it costs today is unknown. Fewer than month_to_date_days_elapsed says some of the month is not in the figure. 0 for an object with no cluster behind it. For a project a day is counted against the clusters behind it that day, as trend_30d's clusters_total says: the ones metered under the project's stamp that day, and the ones it holds now that were not metered under another project that day, so one it holds now that nothing metered is a gap. A project that holds no cluster now therefore counts the whole days its moved or deleted clusters were metered under it, and not today.
0 <= x <= 31month_to_date_cents counted in hours rather than whole days: the hours of the month that elapsed since each cluster behind the object was first priced, against the ones a metering pass priced, summed over those clusters. A day with one missed hour is a whole gap in month_to_date_days_metered and one hour of 24 here. Null when it cannot be counted the way the figure was summed: for a project or a credential, whose month sums the month rows stamped with it while a cluster's hours are counted for the cluster whatever it was stamped with, for an object with no cluster behind it, and when any cluster behind it was never priced.
Show child attributes
Show child attributes
Why an application's cost moved over the comparison its cost card makes: the first seven days of the 30-day trend against the last seven complete ones, each scaled to a month, both fully metered. A cause is named only when the platform can tie the movement to an event it recorded and the event's size agrees with what moved; otherwise the state says the movement is unexplained (every source read, nothing fits) or unknown (a source could not be read or does not reach back far enough), never a guess.
Show child attributes
Show child attributes