Update an Instance Group
patch
/api/v2/instance_groups/{id}/
Make a PUT or PATCH request to this resource to update this instance group. The following fields may be modified:
-
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=""
)
For a PATCH request, include only the fields that are being modified.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : InstanceGroup
Type:
Show Source
object
-
capacity:
string
Title:
Capacity
Read Only:true
-
consumed_capacity:
string
Title:
Consumed capacity
Read Only:true
-
created:
string
Title:
Created
Read Only:true
-
credential:
integer
Title:
Credential
-
id:
integer
Title:
ID
Read Only:true
-
instances:
string
Title:
Instances
Read Only:true
-
is_container_group:
boolean
Title:
Is container group
Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. -
jobs_running:
string
Title:
Jobs running
Read Only:true
-
jobs_total:
integer
Title:
Jobs total
Read Only:true
Count of all jobs that target this instance group -
max_concurrent_jobs:
integer
Title:
Max Concurrent Jobs
Minimum Value:0
Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. -
max_forks:
integer
Title:
Max Forks
Minimum Value:0
Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. -
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:250
-
percent_capacity_remaining:
string
Title:
Percent capacity remaining
Read 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 Minimum
Minimum Value:0
Static minimum number of Instances that will be automatically assign to this group when new instances come online. -
policy_instance_percentage:
integer
Title:
Policy Instance Percentage
Minimum Value:0
Maximum Value:100
Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. - related: string
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
Nested Schema : policy_instance_list
Type:
array
List 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
200 Response
Root Schema : InstanceGroup
Type:
Show Source
object
-
capacity:
string
Title:
Capacity
Read Only:true
-
consumed_capacity:
string
Title:
Consumed capacity
Read Only:true
-
created:
string
Title:
Created
Read Only:true
-
credential:
integer
Title:
Credential
-
id:
integer
Title:
ID
Read Only:true
-
instances:
string
Title:
Instances
Read Only:true
-
is_container_group:
boolean
Title:
Is container group
Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. -
jobs_running:
string
Title:
Jobs running
Read Only:true
-
jobs_total:
integer
Title:
Jobs total
Read Only:true
Count of all jobs that target this instance group -
max_concurrent_jobs:
integer
Title:
Max Concurrent Jobs
Minimum Value:0
Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. -
max_forks:
integer
Title:
Max Forks
Minimum Value:0
Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. -
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:250
-
percent_capacity_remaining:
string
Title:
Percent capacity remaining
Read 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 Minimum
Minimum Value:0
Static minimum number of Instances that will be automatically assign to this group when new instances come online. -
policy_instance_percentage:
integer
Title:
Policy Instance Percentage
Minimum Value:0
Maximum Value:100
Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. - related: string
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
Nested Schema : policy_instance_list
Type:
array
List of exact-match Instances that will be assigned to this group
Show Source
-
Array of:
string
Minimum Length:
1