Query category complement costs

Collections APIs / Querying by category / Query complement costs of a category

Query complement costs of a category

Use the following request to query the complement costs of a category, which includes all domain costs not included in any of the collections in the category.

Request

GET /model/collections/query/complement?category=<string>&window=<string>

Examples

GET /model/collections/query/complement?category=Team&window=30d

{
    "window": {
        "start": "2023-01-01T00:00:00Z",
        "end": "2023-02-01T00:00:00Z"
    },
    "data": {
        "cost": {
            "totalCost": 2000.0,
            "idleCost": 40.0,
            "domainCosts": {
                "cloudCost": {
                    "totalCost": 1800.0
                },
                "kubernetesCost": {
                    "totalCost": 200.0,
                    "idleCost": 40.0
                }
            }
        }
    }
}

Query complement cloud costs of a category

Use the following request to query the complement cloud costs of a category, which includes only the cloud costs not included in any of the collections in the category. Optional pagination and filtering parameters are provided for navigating the data, similar to the Cloud Costs API.

Request

GET /model/collections/query/complement/cloud?category=<string>&window=<string>(&aggregate=<string>&filter=<string>&limit=<number>&offset=<number>)

Examples

GET /model/collections/query/complement/cloud?category=Team&window=30d

{
    "window": {
        "start": "2023-01-01T00:00:00Z",
        "end": "2023-02-01T00:00:00Z"
    },
    "data": {
        "cost": {
            "totalCost": 100.0,
            "domainCosts": {
                "cloudCost": {
                    "totalCost": 100.0
                }
            }
        }
    }
}

GET /model/collections/query/complement/cloud?category=Team&window=30d&aggregate=service

{
    "window": {
        "start": "2023-01-01T00:00:00Z",
        "end": "2023-02-01T00:00:00Z"
    },
    "data": {
        "cost": {
            "totalCost": 100.0,
            "domainCosts": {
                "cloudCost": {
                    "totalCost": 100.0
                }
            }
        },
        "itemCount": 75,
        "items": [
            {
                "cost": 20.0,
                "name": "AmazonEC2"
            },
            {
                "cost": 10.0,
                "name": "AWS ELB"
            },
            ...
            {
                "cost": 5.0,
                "name": "Microsoft.Compute"
            }
        ]
    }
}

GET /model/collections/query/complement/cloud?category=Team&window=30d&aggregate=providerID&filter=service:"AmazonEC2"

{
    "window": {
        "start": "2023-01-01T00:00:00Z",
        "end": "2023-02-01T00:00:00Z"
    },
    "data": {
        "cost": {
            "totalCost": 20.0,
            "domainCosts": {
                "cloudCost": {
                    "totalCost": 20.0
                }
            }
        },
        "itemCount": 2,
        "items": [
            {
                "cost": 12.0,
                "name": "i-nrfu3q8i475"
            },
            {
                "cost": 8.0,
                "name": "i-je1823e3477"
            }
        ]
    }
}

Query complement Kubernetes costs for a category

Use the following request to query the complement Kubernetes costs of a category, which includes only the Kubernetes not included in any of the collections in the category. Optional pagination and filtering parameters are provided for navigating the data, similar to the Allocation API.

Request

GET /model/collections/query/complement/kubernetes?category=<string>&window=<string>(&aggregate=<string>&filter=<string>&limit=<number>&offset=<number>)

Examples

GET /model/collection/query/complement/kubernetes?category=Team&window=30d

{
    "window": {
        "start": "2023-01-01T00:00:00Z",
        "end": "2023-02-01T00:00:00Z"
    },
    "data": {
        "cost": {
            "totalCost": 100.0,
            "idleCost": 20.0,
            "domainCosts": {
                "kubernetesCost": {
                    "totalCost": 100.0,
                    "idleCost": 20.0
                }
            }
        }
    }
}

GET /model/collections/query/complement/kubernetes?category=Team&window=30d&aggregate=namespace

{
    "window": {
        "start": "2023-01-01T00:00:00Z",
        "end": "2023-02-01T00:00:00Z"
    },
    "data": {
        "cost": {
            "totalCost": 100.0,
            "idleCost": 20.0,
            "domainCosts": {
                "kubernetesCost": {
                    "totalCost": 100.0,
                    "idleCost": 20.0
                }
            }
        },
        "itemCount": 75,
        "items": [
            {
                "cost": 20.0,
                "name": "kubecost"
            },
            {
                "cost": 10.0,
                "name": "default"
            },
            ...
            {
                "cost": 5.0,
                "name": "kube-system"
            }
        ]
    }
}

GET /model/collections/query/complement/kubernetes?category=Team&window=30d&aggregate=controller&filter=namespace:"kubecost"

{
    "window": {
        "start": "2023-01-01T00:00:00Z",
        "end": "2023-02-01T00:00:00Z"
    },
    "data": {
        "cost": {
            "totalCost": 20.0,
            "idleCost": 5.0,
            "domainCosts": {
                "kubernetesCost": {
                    "totalCost": 20.0,
                    "idleCost": 5.0
                }
            }
        },
        "itemCount": 2,
        "items": [
            {
                "cost": 12.0,
                "name": "cost-analyzer"
            },
            {
                "cost": 8.0,
                "name": "aggregator"
            }
        ]
    }
}