Get cost report resources (pay-as-you-go only)

Get a detailed cost report for a given period and specific resources. Requested period should not exceed 31 days.

Note: This report assumes there are no active commit features in the billing plan. If there are active commit features (pre-paid resources) in your plan, use /v1/reservation_cost_report/totals, as the results from this report will not be accurate.

Data from the past hour may not reflect the full set of statistics. For the most complete and accurate results, we recommend accessing the data at least one hour after the relevant time period. Updates are generally available within a 24-hour window, though timing can vary. Scheduled maintenance or other exceptions may occasionally cause delays beyond 24 hours.

POST /cloud/v1/cost_report/resources

Python

Python

import os
from datetime import datetime
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
cost_report_detailed = client.cloud.cost_reports.get_detailed(
    time_from=datetime.fromisoformat("2023-01-01T00:00:00"),
    time_to=datetime.fromisoformat("2023-02-01T00:00:00"),
)
print(cost_report_detailed.count)

package main

import (
	"context"
	"fmt"
	"time"

	"github.com/G-Core/gcore-go"
	"github.com/G-Core/gcore-go/cloud"
	"github.com/G-Core/gcore-go/option"
)

func main() {
	client := gcore.NewClient(
		option.WithAPIKey("My API Key"),
	)
	costReportDetailed, err := client.Cloud.CostReports.GetDetailed(context.TODO(), cloud.CostReportGetDetailedParams{
		TimeFrom: time.Now(),
		TimeTo:   time.Now(),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", costReportDetailed.Count)
}

curl --request POST \
  --url https://api.gcore.com/cloud/v1/cost_report/resources \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 50,
  "offset": 0,
  "order_by": [
    "project.desc"
  ],
  "projects": [
    16,
    17,
    18,
    19,
    20
  ],
  "regions": [
    18,
    76
  ],
  "response_format": "json",
  "schema_filter": {
    "field": "flavor",
    "type": "instance",
    "values": [
      "g1-standard-1-2"
    ]
  },
  "tags": {
    "condition_type": "OR",
    "conditions": [
      {
        "key": "os_version",
        "strict": true,
        "value": "22.04"
      },
      {
        "key": "os_version",
        "strict": true,
        "value": "23.04"
      }
    ]
  },
  "time_from": "2024-08-01T00:00:00",
  "time_to": "2024-09-01T00:00:00",
  "types": [
    "egress_traffic",
    "instance"
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    limit: 50,
    offset: 0,
    order_by: ['project.desc'],
    projects: [16, 17, 18, 19, 20],
    regions: [18, 76],
    response_format: 'json',
    schema_filter: {field: 'flavor', type: 'instance', values: ['g1-standard-1-2']},
    tags: {
      condition_type: 'OR',
      conditions: [
        {key: 'os_version', strict: true, value: '22.04'},
        {key: 'os_version', strict: true, value: '23.04'}
      ]
    },
    time_from: '2024-08-01T00:00:00',
    time_to: '2024-09-01T00:00:00',
    types: ['egress_traffic', 'instance']
  })
};

fetch('https://api.gcore.com/cloud/v1/cost_report/resources', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/cloud/v1/cost_report/resources",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'limit' => 50,
    'offset' => 0,
    'order_by' => [
        'project.desc'
    ],
    'projects' => [
        16,
        17,
        18,
        19,
        20
    ],
    'regions' => [
        18,
        76
    ],
    'response_format' => 'json',
    'schema_filter' => [
        'field' => 'flavor',
        'type' => 'instance',
        'values' => [
                'g1-standard-1-2'
        ]
    ],
    'tags' => [
        'condition_type' => 'OR',
        'conditions' => [
                [
                                'key' => 'os_version',
                                'strict' => true,
                                'value' => '22.04'
                ],
                [
                                'key' => 'os_version',
                                'strict' => true,
                                'value' => '23.04'
                ]
        ]
    ],
    'time_from' => '2024-08-01T00:00:00',
    'time_to' => '2024-09-01T00:00:00',
    'types' => [
        'egress_traffic',
        'instance'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://api.gcore.com/cloud/v1/cost_report/resources")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"limit\": 50,\n  \"offset\": 0,\n  \"order_by\": [\n    \"project.desc\"\n  ],\n  \"projects\": [\n    16,\n    17,\n    18,\n    19,\n    20\n  ],\n  \"regions\": [\n    18,\n    76\n  ],\n  \"response_format\": \"json\",\n  \"schema_filter\": {\n    \"field\": \"flavor\",\n    \"type\": \"instance\",\n    \"values\": [\n      \"g1-standard-1-2\"\n    ]\n  },\n  \"tags\": {\n    \"condition_type\": \"OR\",\n    \"conditions\": [\n      {\n        \"key\": \"os_version\",\n        \"strict\": true,\n        \"value\": \"22.04\"\n      },\n      {\n        \"key\": \"os_version\",\n        \"strict\": true,\n        \"value\": \"23.04\"\n      }\n    ]\n  },\n  \"time_from\": \"2024-08-01T00:00:00\",\n  \"time_to\": \"2024-09-01T00:00:00\",\n  \"types\": [\n    \"egress_traffic\",\n    \"instance\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v1/cost_report/resources")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"limit\": 50,\n  \"offset\": 0,\n  \"order_by\": [\n    \"project.desc\"\n  ],\n  \"projects\": [\n    16,\n    17,\n    18,\n    19,\n    20\n  ],\n  \"regions\": [\n    18,\n    76\n  ],\n  \"response_format\": \"json\",\n  \"schema_filter\": {\n    \"field\": \"flavor\",\n    \"type\": \"instance\",\n    \"values\": [\n      \"g1-standard-1-2\"\n    ]\n  },\n  \"tags\": {\n    \"condition_type\": \"OR\",\n    \"conditions\": [\n      {\n        \"key\": \"os_version\",\n        \"strict\": true,\n        \"value\": \"22.04\"\n      },\n      {\n        \"key\": \"os_version\",\n        \"strict\": true,\n        \"value\": \"23.04\"\n      }\n    ]\n  },\n  \"time_from\": \"2024-08-01T00:00:00\",\n  \"time_to\": \"2024-09-01T00:00:00\",\n  \"types\": [\n    \"egress_traffic\",\n    \"instance\"\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "count": 1,
  "results": [
    {
      "billing_feature_name": "AI Infrastructure: bm3-ai-1xlarge-h100-80-8 (2 x Intel Xeon 8480+, 2TB RAM, 8x3.84 TB NVMe, 8x Nvidia H100, IB 3.2 Tbit/s, 2x100Gbit/s Ethernet)  Luxembourg-2 - PAYG",
      "billing_metric_name": "bm3-ai-1xlarge-h100-80-8_min",
      "billing_value": 1000,
      "billing_value_unit": "minutes",
      "cost": 1000,
      "currency": "EUR",
      "err": null,
      "first_seen": "2024-07-01T00:00:30Z",
      "flavor": "bm3-ai-1xlarge-h100-80-8",
      "last_name": "ai_cluster_name",
      "last_seen": "2024-07-30T23:59:30Z",
      "project_id": 10,
      "region": 76,
      "region_id": 76,
      "tags": [
        {
          "os_distro": "ubuntu"
        },
        {
          "os_version": "22.04"
        }
      ],
      "type": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Body

application/json

time_from · string<date-time> · required

The start date of the report period (ISO 8601). The report starts from the beginning of this day in UTC.

Example:

"2023-01-01T00:00:00Z"

time_to · string<date-time> · required

The end date of the report period (ISO 8601). The report ends just before the beginning of this day in UTC.

Example:

"2023-02-01T00:00:00Z"

enable_last_day · boolean · default: false

Expenses for the last specified day are taken into account. As the default, False.

Example:

false

limit · integer · default: 10

The response resources limit. Defaults to 10.

Example:

10

offset · integer · default: 0

The response resources offset.

Required range: x >= 0

Example:

0

order_by · enum<string>[]

List of sorting criteria in 'field.direction' format.

Available options: billing_value.asc, billing_value.desc, first_seen.asc, first_seen.desc, last_name.asc, last_name.desc, last_seen.asc, last_seen.desc, project.asc, project.desc, region.asc, region.desc, type.asc, type.desc

Example:

["project.asc", "region.desc"]

projects · integer[]

List of project IDs

Example:

[16, 17, 18, 19, 20]

regions · integer[]

List of region IDs.

Example:

[1, 2, 3]

response_format · enum<string> · default: json

Format of the response (csv or json).

Available options: csv_records, json

Examples:

"csv_records"

"json"

rounding · boolean · default: true

Round cost values to 5 decimal places. When false, returns full precision.

schema_filter · SchemaFilterSnapshotSerializer · object

Extended filter for field filtering.

SchemaFilterSnapshotSerializer

SchemaFilterInstanceSerializer

SchemaFilterAiClusterSerializer

SchemaFilterAiVirtualClusterSerializer

SchemaFilterBasicVmSerializer

SchemaFilterBaremetalSerializer

SchemaFilterVolumeSerializer

SchemaFilterFileShareSerializer

SchemaFilterImageSerializer

SchemaFilterFloatingIpSerializer

SchemaFilterEgressTrafficSerializer

SchemaFilterLoadBalancerSerializer

SchemaFilterExternalIpSerializer

SchemaFilterBackupSerializer

SchemaFilterLogIndexSerializer

SchemaFilterFunctionsSerializer

SchemaFilterFunctionsCallsSerializer

SchemaFilterFunctionsTrafficSerializer

SchemaFilterContainersSerializer

SchemaFilterInferenceSerializer

SchemaFilterDBAASPostgreSQLVolumeSerializer

SchemaFilterDBAASPostgreSQLPublicNetworkSerializer

SchemaFilterDBAASPostgreSQLCPUSerializer

SchemaFilterDBAASPostgreSQLMemorySerializer

SchemaFilterDBAASPostgreSQLPoolerSerializer

Show child attributes

Example:

{
  "field": "flavor",
  "type": "instance",
  "values": ["g1-standard-1-2"]
}

sorting · CostReportResourcesSortingRequestSerializer · object[] · deprecated

(DEPRECATED Use 'order_by' instead) List of sorting filters (JSON objects) fields: project. directions: asc, desc.

Show child attributes

tags · TagsFilterSerializer · object

Filter by tags

Show child attributes

Example:

{
  "condition_type": "OR",
  "conditions": [
    {
      "key": "os_version",
      "strict": true,
      "value": "22.04"
    },
    {
      "key": "os_version",
      "strict": true,
      "value": "23.04"
    }
  ]
}

types · enum<string>[]

List of resource types to be filtered in the report.

Resource types for prebilling report

Available options: ai_cluster, ai_virtual_cluster, backup, baremetal, basic_vm, containers, dbaas_postgresql_connection_pooler, dbaas_postgresql_cpu, dbaas_postgresql_memory, dbaas_postgresql_public_network, dbaas_postgresql_volume, egress_traffic, external_ip, file_share, floatingip, functions, functions_calls, functions_traffic, image, inference, instance, load_balancer, log_index, snapshot, volume

Example:

["egress_traffic", "instance"]

Response

200 - application/json

OK

count · integer · required

Count of all the resources

Required range: x >= 0

Example:

1

price_status · enum<string> · required

Price status for the UI, type: string

Available options: error, hide, show

results · (ResourceAiClusterWithCostSerializer · object | ResourceAiVirtualClusterWithCostSerializer · object | ResourceBaremetalWithCostSerializer · object | ResourceBasicVmWithCostSerializer · object | ResourceBackupWithCostSerializer · object | ResourceContainerWithCostSerializer · object | ResourceEgressTrafficWithCostSerializer · object | ResourceExternalIpWithCostSerializer · object | ResourceFileShareWithCostSerializer · object | ResourceFloatingIpWithCostSerializer · object | ResourceFunctionsWithCostSerializer · object | ResourceFunctionCallsWithCostSerializer · object | ResourceFunctionEgressTrafficWithCostSerializer · object | ResourceImagesWithCostSerializer · object | ResourceInferenceWithCostSerializer · object | ResourceInstanceWithCostSerializer · object | ResourceLoadBalancerWithCostSerializer · object | ResourceLogIndexWithCostSerializer · object | ResourceSnapshotWithCostSerializer · object | ResourceVolumeWithCostSerializer · object | ResourceDBAASPostgreSQLPoolerWithCostSerializer · object | ResourceDBAASPostgreSQLMemoryWithCostSerializer · object | ResourceDBAASPostgreSQLPublicNetworkWithCostSerializer · object | ResourceDBAASPostgreSQLCPUWithCostSerializer · object | ResourceDBAASPostgreSQLVolumeWithCostSerializer · object)[] · required

ResourceAiClusterWithCostSerializer

ResourceAiVirtualClusterWithCostSerializer

ResourceBaremetalWithCostSerializer

ResourceBasicVmWithCostSerializer

ResourceBackupWithCostSerializer

ResourceContainerWithCostSerializer

ResourceEgressTrafficWithCostSerializer

ResourceExternalIpWithCostSerializer

ResourceFileShareWithCostSerializer

ResourceFloatingIpWithCostSerializer

ResourceFunctionsWithCostSerializer

ResourceFunctionCallsWithCostSerializer

ResourceFunctionEgressTrafficWithCostSerializer

ResourceImagesWithCostSerializer

ResourceInferenceWithCostSerializer

ResourceInstanceWithCostSerializer

ResourceLoadBalancerWithCostSerializer

ResourceLogIndexWithCostSerializer

ResourceSnapshotWithCostSerializer

ResourceVolumeWithCostSerializer

ResourceDBAASPostgreSQLPoolerWithCostSerializer

ResourceDBAASPostgreSQLMemoryWithCostSerializer

ResourceDBAASPostgreSQLPublicNetworkWithCostSerializer

ResourceDBAASPostgreSQLCPUWithCostSerializer

ResourceDBAASPostgreSQLVolumeWithCostSerializer

Show child attributes