Retrieve an Instance Group

get

/api/v2/instance_groups/{id}/

Make GET request to this resource to retrieve a single instance group record containing the following fields:

  • id: Database ID for this instance group. (integer)
  • type: Data type for this instance group. (choice)
  • url: URL for this instance group. (string)
  • related: Data structure with URLs of related resources. (object)
  • name: Name of this instance group. (string)
  • created: Timestamp when this instance group was created. (datetime)
  • modified: Timestamp when this instance group was last modified. (datetime)
  • capacity: (field)
  • committed_capacity: (field)
  • consumed_capacity: (field)
  • percent_capacity_remaining: (field)
  • jobs_running: Count of jobs in the running or waiting state that are targeted for this instance group (integer)
  • jobs_total: Count of all jobs that target this instance group (integer)
  • instances: (field)
  • controller: Instance Group to remotely control this group. (id)
  • is_controller: Indicates whether instance group controls any other group (boolean)
  • is_isolated: Indicates whether instances in this group are isolated.Isolated groups have a designated controller group. (boolean)
  • is_containerized: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)
  • credential: (id)
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json)
  • pod_spec_override: (string)
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

200 Response

Back to Top