Jump to

• Request
• Response

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)
• consumed_capacity: (field)
• percent_capacity_remaining: (field)
• jobs_running: (field)
• max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)
• max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)
• jobs_total: Count of all jobs that target this instance group (integer)
• instances: (field)
• is_container_group: 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

• application/json

Path Parameters

• id(required): string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : InstanceGroup

Type: object

Show Source

• 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
  Title: Related

  Read Only: true
• summary_fields: string
  Title: Summary fields

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true

{
    "properties":{
        "capacity":{
            "readOnly":true,
            "title":"Capacity",
            "type":"string"
        },
        "consumed_capacity":{
            "readOnly":true,
            "title":"Consumed capacity",
            "type":"string"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential":{
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "instances":{
            "readOnly":true,
            "title":"Instances",
            "type":"string"
        },
        "is_container_group":{
            "description":"Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster.",
            "title":"Is container group",
            "type":"boolean"
        },
        "jobs_running":{
            "readOnly":true,
            "title":"Jobs running",
            "type":"string"
        },
        "jobs_total":{
            "description":"Count of all jobs that target this instance group",
            "readOnly":true,
            "title":"Jobs total",
            "type":"integer"
        },
        "max_concurrent_jobs":{
            "description":"Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced.",
            "minimum":"0",
            "title":"Max Concurrent Jobs",
            "type":"integer"
        },
        "max_forks":{
            "description":"Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced.",
            "minimum":"0",
            "title":"Max Forks",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"250",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "percent_capacity_remaining":{
            "readOnly":true,
            "title":"Percent capacity remaining",
            "type":"string"
        },
        "pod_spec_override":{
            "title":"Pod spec override",
            "type":"string",
            "x-nullable":true
        },
        "policy_instance_list":{
            "description":"List of exact-match Instances that will be assigned to this group",
            "items":{
                "minLength":"1",
                "type":"string"
            },
            "type":"array"
        },
        "policy_instance_minimum":{
            "description":"Static minimum number of Instances that will be automatically assign to this group when new instances come online.",
            "minimum":"0",
            "title":"Policy Instance Minimum",
            "type":"integer"
        },
        "policy_instance_percentage":{
            "description":"Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.",
            "maximum":"100",
            "minimum":"0",
            "title":"Policy Instance Percentage",
            "type":"integer"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

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

{
    "description":"List of exact-match Instances that will be assigned to this group",
    "items":{
        "minLength":"1",
        "type":"string"
    },
    "type":"array"
}

Back to Top