StorageUsage

Returns the aggregated historical storage usage of all registered engines over time, optionally with a projection of future storage usage.

SecurityApiKeyAuth

Request

query Parameters

start_date	string <date-time> Report start date/time. Defaults to first API request. Example: start_date=2022-05-29T19:00:00.000Z
end_date	string <date-time> Report end date/time. Defaults to current time. Example: end_date=2022-06-07T19:10:00.000Z
include_projection	boolean Whether to compute a projection of future storage usage.
engine_ids	Array of strings The list of engine ids to aggregate data for. By default aggregating data for all engines.
dsource_ids	Array of strings The list of dSource ids to aggregate data for. By default aggregating data for all dSources.
vdb_ids	Array of strings The list of VDB ids to aggregate data for. By default aggregating data for all VDBs.
cdb_ids	Array of strings The list of CDB ids to aggregate data for. By default aggregating data for all CDBs.
vcdb_ids	Array of strings The list of VCDB ids to aggregate data for. By default aggregating data for all VCDBs.

Responses

200

Returns the aggregated historical storage usage of all registered engines over time.

get/historical-storage-summary-aggregate

Response samples

application/json

{"historical_data_points": [{"timestamp": "2019-08-24",
"free_storage": 0,
"used_storage": 0,
"reserved_storage": 0,
"dsource_total_size": 0,
"dsource_base_size": 0,
"dsource_logs_size": 0,
"dsource_snapshot_size": 0,
"vdb_total_size": 0,
"vdb_base_size": 0,
"vdb_logs_size": 0,
"vdb_snapshot_size": 0,
"cdb_total_size": 0,
"cdb_base_size": 0,
"cdb_logs_size": 0,
"cdb_snapshot_size": 0,
"vcdb_total_size": 0,
"vcdb_base_size": 0,
"vcdb_logs_size": 0,
"vcdb_snapshot_size": 0,
"heldspace_total_size": 0,
"heldspace_base_size": 0,
"heldspace_logs_size": 0,
"heldspace_snapshot_size": 0,
"deleted_total_size": 0,
"deleted_base_size": 0,
"deleted_logs_size": 0,
"deleted_snapshot_size": 0
}
],
"projected_data_points": [{"timestamp": "2019-08-24",
"free_storage": 0,
"used_storage": 0,
"reserved_storage": 0,
"dsource_total_size": 0,
"dsource_base_size": 0,
"dsource_logs_size": 0,
"dsource_snapshot_size": 0,
"vdb_total_size": 0,
"vdb_base_size": 0,
"vdb_logs_size": 0,
"vdb_snapshot_size": 0,
"cdb_total_size": 0,
"cdb_base_size": 0,
"cdb_logs_size": 0,
"cdb_snapshot_size": 0,
"vcdb_total_size": 0,
"vcdb_base_size": 0,
"vcdb_logs_size": 0,
"vcdb_snapshot_size": 0,
"heldspace_total_size": 0,
"heldspace_base_size": 0,
"heldspace_logs_size": 0,
"heldspace_snapshot_size": 0
}
]
}

Returns the historical storage usage by engine over time, optionally with a projection of future storage usage.

SecurityApiKeyAuth

Request

query Parameters

start_date	string <date-time> Report start date/time. Defaults to first API request. Example: start_date=2022-05-29T19:00:00.000Z
end_date	string <date-time> Report end date/time. Defaults to current time. Example: end_date=2022-06-07T19:10:00.000Z
include_projection	boolean Whether to compute a projection of future storage usage.
engine_ids	Array of strings The list of engine ids to include in the response. By default returning data for all engines.

Responses

200

Returns the historical storage usage by engine over time.

get/historical-storage-summary-by-engine

Response samples

application/json

{"engines": [{"engine_id": "string",
"engine_name": "string",
"historical_data_points": [{"timestamp": "2019-08-24",
"free_storage": 0,
"used_storage": 0,
"reserved_storage": 0,
"dsource_total_size": 0,
"dsource_base_size": 0,
"dsource_logs_size": 0,
"dsource_snapshot_size": 0,
"vdb_total_size": 0,
"vdb_base_size": 0,
"vdb_logs_size": 0,
"vdb_snapshot_size": 0,
"cdb_total_size": 0,
"cdb_base_size": 0,
"cdb_logs_size": 0,
"cdb_snapshot_size": 0,
"vcdb_total_size": 0,
"vcdb_base_size": 0,
"vcdb_logs_size": 0,
"vcdb_snapshot_size": 0,
"heldspace_total_size": 0,
"heldspace_base_size": 0,
"heldspace_logs_size": 0,
"heldspace_snapshot_size": 0,
"deleted_total_size": 0,
"deleted_base_size": 0,
"deleted_logs_size": 0,
"deleted_snapshot_size": 0
}
],
"projected_data_points": [{"timestamp": "2019-08-24",
"free_storage": 0,
"used_storage": 0,
"reserved_storage": 0,
"dsource_total_size": 0,
"dsource_base_size": 0,
"dsource_logs_size": 0,
"dsource_snapshot_size": 0,
"vdb_total_size": 0,
"vdb_base_size": 0,
"vdb_logs_size": 0,
"vdb_snapshot_size": 0,
"cdb_total_size": 0,
"cdb_base_size": 0,
"cdb_logs_size": 0,
"cdb_snapshot_size": 0,
"vcdb_total_size": 0,
"vcdb_base_size": 0,
"vcdb_logs_size": 0,
"vcdb_snapshot_size": 0,
"heldspace_total_size": 0,
"heldspace_base_size": 0,
"heldspace_logs_size": 0,
"heldspace_snapshot_size": 0
}
]
}
]
}

➔ Next to Reporting