clusters_list_kubernetes {civis}

List Kubernetes Clusters

Description

List Kubernetes Clusters

Usage

clusters_list_kubernetes(
  organization_id = NULL,
  organization_slug = NULL,
  raw_cluster_slug = NULL,
  exclude_inactive_orgs = NULL,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Arguments

organization_id

integer optional. The ID of this cluster's organization. Cannot be used along with the organization slug.

organization_slug

string optional. The slug of this cluster's organization. Cannot be used along with the organization ID.

raw_cluster_slug

string optional. The slug of this cluster's raw configuration.

exclude_inactive_orgs

boolean optional. When true, excludes KubeClusters associated with inactive orgs. Defaults to false.

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 organization_id. Must be one of: organization_id, 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 cluster.

organizationId

string, The id of this cluster's organization.

organizationName

string, The name of this cluster's organization.

organizationSlug

string, The slug of this cluster's organization.

rawClusterSlug

string, The slug of this cluster's raw configuration.

customPartitions

boolean, Whether this cluster has a custom partition configuration.

clusterPartitions

array, An array containing the following fields:

• clusterPartitionId integer, The ID of this cluster partition.

• name string, The name of the cluster partition.

• labels array, Labels associated with this partition.

• instanceConfigs array, The instances configured for this cluster partition.

• defaultInstanceConfigId integer, The id of the InstanceConfig that is the default for this partition.

isNatEnabled

boolean, Whether this cluster needs a NAT gateway or not.