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) -
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
Query Parameters
-
search(optional): string
A search term.
Root Schema : schema
Example:
{
"name":"foobar"
}Response
Supported Media Types
- application/json
200 Response
Example Response (application/json)
{
"capacity":0,
"committed_capacity":0,
"consumed_capacity":0,
"controller":null,
"created":"2018-02-01T08:00:00.000000Z",
"credential":null,
"id":2,
"instances":0,
"is_containerized":false,
"is_controller":false,
"is_isolated":false,
"jobs_running":0,
"jobs_total":0,
"modified":"2018-02-01T08:00:00.000000Z",
"name":"foobar",
"percent_capacity_remaining":0,
"pod_spec_override":"",
"policy_instance_list":[
],
"policy_instance_minimum":0,
"policy_instance_percentage":0,
"related":{
"instances":"/api/v2/instance_groups/2/instances/",
"jobs":"/api/v2/instance_groups/2/jobs/"
},
"summary_fields":{
"user_capabilities":{
"delete":true,
"edit":true
}
},
"type":"instance_group",
"url":"/api/v2/instance_groups/2/"
}400 Response
Example Response (application/json)
{
"policy_instance_list":[
"Containerized instances may not be managed via the API"
]
}