Skip to content

Marketplace Category Component Usages

Operations Summary

Method Endpoint Description
GET /api/marketplace-category-component-usages/ List aggregated category component usages
GET /api/marketplace-category-component-usages/{id}/ Retrieve an aggregated category component usage record

List aggregated category component usages

1
2
3
4
5
6
    Returns a paginated list of aggregated component usages for marketplace categories.
    This data is scoped to either a customer or a project and represents the total usage
    of a component type (e.g., total 'CPU hours' used across all resources of a certain category
    within a project).

    The list **must** be filtered by a `scope` parameter (either a customer or project URL).

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-category-component-usages/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_component_usages import marketplace_category_component_usages_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_component_usages_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_category_component_usages_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceCategoryComponentUsagesList } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryComponentUsagesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
date_after string (date)
date_before string (date)
field array
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
name string Display name for the measured unit, for example, Floating IP.
type string Unique internal name of the measured unit, for example floating_ip.
measured_unit string Unit of measurement, for example, GB.
category_title string
category_uuid string (uuid)
date string (date)
reported_usage integer (int64)
fixed_usage integer (int64)
scope string

Retrieve an aggregated category component usage record

Returns the details of a single aggregated usage record for a category component, identified by its database ID.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-category-component-usages/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_component_usages import marketplace_category_component_usages_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_component_usages_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: marketplace_category_component_usages_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryComponentUsagesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryComponentUsagesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this category component usage.
Name Type
field array

200 -

Field Type Description
name string Display name for the measured unit, for example, Floating IP.
type string Unique internal name of the measured unit, for example floating_ip.
measured_unit string Unit of measurement, for example, GB.
category_title string
category_uuid string (uuid)
date string (date)
reported_usage integer (int64)
fixed_usage integer (int64)
scope string