client.clusters.list_kubernetes_instance_configs_active_workloads

A method of the Clusters endpoint.

list_kubernetes_instance_configs_active_workloads(id: int, *, state: str = None) → ListResponse

List active workloads in an Instance Config

API URL: GET /clusters/kubernetes/instance_configs/{id}/active_workloads

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

Parameters:

idint

The id of the instance config.

statestr, optional

If specified, return workloads in these states. It accepts a comma- separated list, possible values are pending, running

Returns:

civis.ListResponse

• idint

  The id of this deployment.

• base_typestr

  The base type of this deployment.

• base_idint

  The id of the base object associated with this deployment.

• base_object_namestr

  The name of the base object associated with this deployment. Null if you do not have permission to read the object.

• job_typestr

  If the base object is a job run you have permission to read, the type of the job. One of “python_script”, “r_script”, “container_script”, or “custom_script”.

• job_idint

  If the base object is a job run you have permission to read, the id of the job.

• job_cancel_requested_atstr (time)

  If the base object is a job run you have permission to read, and it was requested to be cancelled, the timestamp of that request.

• statestr

  The state of this deployment.

• cpuint

  The CPU in millicores requested by this deployment.

• memoryint

  The memory in MB requested by this deployment.

• disk_spaceint

  The disk space in GB requested by this deployment.

• usercivis.Response

  • idint

    The ID of this user.

  • namestr

    This user’s name.

  • usernamestr

    This user’s username.

  • initialsstr

    This user’s initials.

  • onlinebool

    Whether this user is online.

• created_atstr (time)

  The timestamp of when the deployment began.

• cancellablebool

  True if you have permission to cancel this deployment.