client.clusters.list_kubernetes_instance_configs_historical_metrics

A method of the Clusters endpoint.

list_kubernetes_instance_configs_historical_metrics(instance_config_id: int, *, timeframe: str = None, metric: str = None) → ListResponse

Get graphs of historical resource usage in an Instance Config

API URL: GET /clusters/kubernetes/instance_configs/{instance_config_id}/historical_metrics

import civis
client = civis.APIClient()
response = client.clusters.list_kubernetes_instance_configs_historical_metrics(...)

Warning

The method name <client>.clusters.list_kubernetes_instance_configs_historical_metrics is deprecated and will be removed at civis-python v3.0.0 (scheduled for February 2027). Please switch to <client>.clusters.get_kubernetes_instance_configs_historical_metrics for the same method.

Parameters:

instance_config_idint: The ID of this instance config.
timeframestr, optional: The span of time that the graphs cover. Must be one of 1_day, 1_week.
metricstr, optional: The metric to retrieve. Must be one of cpu, memory.

Returns:

civis.Response

instance_config_idint
The ID of this instance config.
metricstr
URL for the graph of historical CPU usage in this instance config.
timeframestr
The span of time that the graphs cover. Must be one of 1_day, 1_week.
unitstr
The unit of the values.
metricscivis.Response
- usedcivis.Response
  
  timesList[int]
  The times associated with data points, in seconds since epoch.
  
  valuesList[float]
  The values of the data points.
- requestedcivis.Response
  
  timesList[int]
  The times associated with data points, in seconds since epoch.
  
  valuesList[float]
  The values of the data points.
- capacitycivis.Response
  
  timesList[int]
  The times associated with data points, in seconds since epoch.
  
  valuesList[float]
  The values of the data points.