Create an Instance Group for a Schedule
post
/api/v2/schedules/{id}/instance_groups/
Make a POST request to this resource with the following instance group fields to create a new instance group associated with this schedule.
-
name: Name of this instance group. (string, required) -
max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=0) -
max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=0) -
is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``) credential: (id, default=``)policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0)policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0)policy_instance_list: List of exact-match Instances that will be assigned to this group (json, default=``)pod_spec_override: (string, default="")
Add Instance Groups for a Schedule:
Make a POST request to this resource with only an id field to associate an
existing instance group with this schedule.
Remove Instance Groups from this Schedule:
Make a POST request to this resource with id and disassociate fields to
remove the instance group from this schedule
without deleting the instance group.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : InstanceGroup
Type:
Show Source
object-
capacity:
string
Title:
CapacityRead Only:true -
consumed_capacity:
string
Title:
Consumed capacityRead Only:true -
created:
string
Title:
CreatedRead Only:true -
credential:
integer
Title:
Credential -
id:
integer
Title:
IDRead Only:true -
instances:
string
Title:
InstancesRead Only:true -
is_container_group:
boolean
Title:
Is container groupIndicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. -
jobs_running:
string
Title:
Jobs runningRead Only:true -
jobs_total:
integer
Title:
Jobs totalRead Only:trueCount of all jobs that target this instance group -
max_concurrent_jobs:
integer
Title:
Max Concurrent JobsMinimum Value:0Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. -
max_forks:
integer
Title:
Max ForksMinimum Value:0Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. -
modified:
string
Title:
ModifiedRead Only:true -
name(required):
string
Title:
NameMinimum Length:1Maximum Length:250 -
percent_capacity_remaining:
string
Title:
Percent capacity remainingRead Only:true -
pod_spec_override:
string
Title:
Pod spec override -
policy_instance_list:
array policy_instance_list
List of exact-match Instances that will be assigned to this group
-
policy_instance_minimum:
integer
Title:
Policy Instance MinimumMinimum Value:0Static minimum number of Instances that will be automatically assign to this group when new instances come online. -
policy_instance_percentage:
integer
Title:
Policy Instance PercentageMinimum Value:0Maximum Value:100Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. - related: string
-
summary_fields:
string
Title:
Summary fieldsRead Only:true -
type:
string
Title:
TypeRead Only:true -
url:
string
Title:
UrlRead Only:true
Nested Schema : policy_instance_list
Type:
arrayList of exact-match Instances that will be assigned to this group
Show Source
-
Array of:
string
Minimum Length:
1
Response
Supported Media Types
- application/json
201 Response
Root Schema : InstanceGroup
Type:
Show Source
object-
capacity:
string
Title:
CapacityRead Only:true -
consumed_capacity:
string
Title:
Consumed capacityRead Only:true -
created:
string
Title:
CreatedRead Only:true -
credential:
integer
Title:
Credential -
id:
integer
Title:
IDRead Only:true -
instances:
string
Title:
InstancesRead Only:true -
is_container_group:
boolean
Title:
Is container groupIndicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. -
jobs_running:
string
Title:
Jobs runningRead Only:true -
jobs_total:
integer
Title:
Jobs totalRead Only:trueCount of all jobs that target this instance group -
max_concurrent_jobs:
integer
Title:
Max Concurrent JobsMinimum Value:0Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. -
max_forks:
integer
Title:
Max ForksMinimum Value:0Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. -
modified:
string
Title:
ModifiedRead Only:true -
name(required):
string
Title:
NameMinimum Length:1Maximum Length:250 -
percent_capacity_remaining:
string
Title:
Percent capacity remainingRead Only:true -
pod_spec_override:
string
Title:
Pod spec override -
policy_instance_list:
array policy_instance_list
List of exact-match Instances that will be assigned to this group
-
policy_instance_minimum:
integer
Title:
Policy Instance MinimumMinimum Value:0Static minimum number of Instances that will be automatically assign to this group when new instances come online. -
policy_instance_percentage:
integer
Title:
Policy Instance PercentageMinimum Value:0Maximum Value:100Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. - related: string
-
summary_fields:
string
Title:
Summary fieldsRead Only:true -
type:
string
Title:
TypeRead Only:true -
url:
string
Title:
UrlRead Only:true
Nested Schema : policy_instance_list
Type:
arrayList of exact-match Instances that will be assigned to this group
Show Source
-
Array of:
string
Minimum Length:
1