Skip to content
StratumStratum Docs

List the group's managed instances with their lifecycle state and health.

GET
/v1/projects/{projectId}/asg/groups/{autoScalingGroupId}/instances
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/projects/example/asg/groups/example/instances \
  --header 'Authorization: Bearer <token>'

Every row the controller tracks, including recently Terminated ones (kept 24 h so a describe shows what just happened). Cedar-gated on asg:DescribeAutoScalingGroup.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string
/^p-[a-z0-9-]+$/
autoScalingGroupId
required
string
/^asg-[a-z0-9]+$/

Responses

Section titled “Responses”

200

Section titled “200”

Managed instances.

Media typeapplication/json
object
items
required
Array<object>
object
instanceId
required
string
availabilityZone
required
string
subnetId
string
launchTemplateVersion

The exact ltv-… the instance was launched from (empty for adopted/attached instances).

string
launchReason
required
string
Allowed values: scale_out replace_unhealthy az_rebalance instance_refresh attached adopted hook_abandoned
lifecycleState
required
string
Allowed values: Pending Pending:Wait Pending:Proceed InService Terminating Terminating:Wait Terminating:Proceed Terminated Detaching Detached Standby
healthStatus
required
string
Allowed values: Healthy Unhealthy
unhealthySince
string format: date-time
protectedFromScaleIn
required
boolean
terminateReason

Why the controller terminated it: scale_in, replace_unhealthy, replaced_externally_terminated, group_deleted, az_rebalance, instance_refresh, hook_abandoned.

string
launchedAt
required
string format: date-time
inServiceAt
string format: date-time
terminatedAt
string format: date-time
lbTargetGroupIds

Target groups the instance is currently registered with.

Array<string>
deregisterAfter

While draining, when the controller will ask Compute to terminate.

string format: date-time
hookId

The lifecycle hook holding the instance in a :Wait state.

string
hookDeadlineAt

When the hook times out to its default result; pushed by heartbeats.

string format: date-time
hookResult

The verdict recorded (by a caller or the timeout) once the row moved to :Proceed.

string
Allowed values: CONTINUE ABANDON

Example 

{
  "items": [
    {
      "launchReason": "scale_out",
      "lifecycleState": "Pending",
      "healthStatus": "Healthy",
      "hookResult": "CONTINUE"
    }
  ]
}

403

Section titled “403”

Authenticated but not authorized.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}

404

Section titled “404”

Resource not found.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}