civis (version 2.1.0)

clusters_list_workers: List Worker Clusters

Description

List Worker Clusters

Usage

clusters_list_workers(limit = NULL, page_num = NULL, order = NULL,
  order_dir = NULL)

Arguments

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 id. Must be one of: 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.

instanceType

string, The EC2 instance types in this cluster.

minInstances

integer, The minimum number of instances in this cluster.

maxInstances

integer, The maximum number of instances in this cluster.

region

string, The AWS region that this cluster is in.

activeJobsCount

integer, The number of jobs currently being run in the cluster.

queuedJobsCount

integer, The number of jobs currently waiting to be run on the cluster.