client.clusters.list_kubernetes_instance_configs_user_statistics

A method of the Clusters endpoint.

list_kubernetes_instance_configs_user_statistics(instance_config_id: int, *, order: str = None, order_dir: str = None) → ListResponse

Get statistics about the current users of an Instance Config

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

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

Parameters:

instance_config_idint: The ID of this instance config.
orderstr, optional: The field on which to order the result set. Defaults to running_deployments. Must be one of pending_memory_requested, pending_cpu_requested, running_memory_requested, running_cpu_requested, pending_deployments, running_deployments.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending). Defaults to desc.

Returns:

civis.ListResponse

user_idstr
The owning user’s ID
user_namestr
The owning user’s name
pending_deploymentsint
The number of deployments belonging to the owning user in “pending” state
pending_memory_requestedint
The sum of memory requests (in MB) for deployments belonging to the owning user in “pending” state
pending_cpu_requestedint
The sum of CPU requests (in millicores) for deployments belonging to the owning user in “pending” state
running_deploymentsint
The number of deployments belonging to the owning user in “running” state
running_memory_requestedint
The sum of memory requests (in MB) for deployments belonging to the owning user in “running” state
running_cpu_requestedint
The sum of CPU requests (in millicores) for deployments belonging to the owning user in “running” state