clusters_list_kubernetes_deployments {civis}

List the deployments associated with a Kubernetes Cluster

Description

List the deployments associated with a Kubernetes Cluster

Usage

clusters_list_kubernetes_deployments(
  id,
  base_type = NULL,
  state = NULL,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Arguments

id

integer required. The id of the cluster.

base_type

string optional. If specified, return deployments of these base types. It accepts a comma-separated list, possible values are 'Notebook', 'Service', 'Run'.

state

string optional. If specified, return deployments in these states. It accepts a comma-separated list, possible values are pending, running, terminated, sleeping

limit

integer optional. Number of results to return. Defaults to its maximum of 50.

page_num

integer optional. Page number of the results to return. Defaults to the first page, 1.

order

string optional. The field on which to order the result set. Defaults to created_at. Must be one of: created_at.

order_dir

string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.

Value

An array containing the following fields:

id

integer, The id of this deployment.

name

string, The name of the deployment.

baseId

integer, The id of the base object associated with the deployment.

baseType

string, The base type of this deployment.

state

string, The state of the deployment.

cpu

integer, The CPU in millicores required by the deployment.

memory

integer, The memory in MB required by the deployment.

diskSpace

integer, The disk space in GB required by the deployment.

instanceType

string, The EC2 instance type requested for the deployment.

author

list, A list containing the following elements:

• id integer, The ID of this user.

• name string, This user's name.

• username string, This user's username.

• initials string, This user's initials.

• online boolean, Whether this user is online.

maxMemoryUsage

number, If the deployment has finished, the maximum amount of memory used during the deployment, in MB.

maxCpuUsage

number, If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.

createdAt

string,

updatedAt

string,