Add ability to read "Allocated Resources" for clusters over API

[stavr666]

NetBox version

v3.5.1

Feature type

Change to existing functionality

Proposed functionality

Return calculated "Allocated Resources" values to API endpoint.

If values stored in DB, add them to endpoints:

• /api/virtualization/clusters/
• /api/virtualization/clusters/{$id}/

Example in current UI:

Returned by API:

Example of expected output from same datapoint:

Database changes, new views or API endpoints - NOT REQUIRED afaik

Use case

Availability to fast-read actual values, without GraphQL or pipelining several API queries.

Target scenarios:

• Resource saturation monitoring per cluster (target values defined either externally or in custom fields).
• Raw resource cost approximation for cloud tenants/projects.

Database changes

No response

External dependencies

No response

[jeremystretch]

Thank you for your interest in extending NetBox. Unfortunately, the information you have provided does not constitute an actionable feature request. Per our contributing guide, a feature request must include a thorough description of the proposed functionality, including any database changes, new views or API endpoints, and so on. It must also include a detailed use case justifying its implementation. If you would like to elaborate on your proposal, please modify your post above. If sufficient detail is not added, this issue will be closed.

[stavr666]

@jeremystretch

thorough description of the proposed functionality

Example added

detailed use case justifying its implementation

It's was justified, as I far as I can. I just wanna directly use data, that already exists in Netbox UI, in our monitoring and reporting solutions, without external resource calculation for each cluster.

P.S. Can add similar example for "clusters" datapoint (without id), if needed.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.