ManagedInstance

A Managed Instance resource.

JSON representation 
{
  "name": string,
  "instance": string,
  "id": string,
  "instanceStatus": enum (Status),
  "version": {
    object (Version)
  },
  "preservedStateFromPolicy": {
    object (PreservedState)
  },
  "preservedStateFromConfig": {
    object (PreservedState)
  },
  "currentAction": enum (InstanceAction),
  "instanceHealth": [
    {
      object (InstanceHealth)
    }
  ],
  "scheduling": {
    object (Scheduling)
  },
  "shutdownDetails": {
    object (ShutdownDetails)
  },
  "lastAttempt": {
    object (LastAttempt)
  },
  "propertiesFromFlexibilityPolicy": {
    object (PropertiesFromFlexibilityPolicy)
  }
}
Fields
name

string

Output only. The name of the instance. The name always exists even if the instance has not yet been created.
instance

string

Output only. The URL of the instance. The URL can exist even if the instance has not yet been created.
id

string (uint64 format)

Output only. The unique identifier for this resource. This field is empty when instance does not exist.
instanceStatus

enum (Status)

Output only. The status of the instance. This field is empty when the instance does not exist.
version

object (Version)

Output only. Intended version of this instance.
preservedStateFromPolicy

object (PreservedState)

Output only. Preserved state generated based on stateful policy for this instance.
preservedStateFromConfig

object (PreservedState)

Output only. Preserved state applied from per-instance config for this instance.
currentAction

enum (InstanceAction)

Output only. The current action that the managed instance group has scheduled for the instance. Possible values:

  • NONE

    The instance is running, and the managed instance group does not have any scheduled actions for this instance.

  • CREATING

    The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.

  • CREATING_WITHOUT_RETRIES

    The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's

    targetSize

    value is decreased instead.

  • RECREATING

    The managed instance group is recreating this instance.

  • DELETING

    The managed instance group is permanently deleting this instance.

  • ABANDONING

    The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.

  • RESTARTING

    The managed instance group is restarting the instance.

  • REFRESHING

    The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.

  • VERIFYING

    The managed instance group has created the instance and it is in the process of being verified.
instanceHealth[]

object (InstanceHealth)

Output only. Health state of the instance per health-check.

Available from 2026-03-01..
scheduling

object (Scheduling)

Output only. Information about the termination timestamp of the instance, if applicable.
shutdownDetails

object (ShutdownDetails)

Output only. Specifies the graceful shutdown details if the instance is in PENDING_STOP state or there is a programmed stop scheduled.
lastAttempt

object (LastAttempt)

Output only. Information about the last attempt to create or delete the instance.
propertiesFromFlexibilityPolicy

object (PropertiesFromFlexibilityPolicy)

Output only. Instance properties selected for this instance resulting from InstanceFlexibilityPolicy.

InstanceHealth

JSON representation 
{
  "healthCheck": string,
  "detailedHealthState": enum (HealthState)
}
Fields
healthCheck

string

Output only. The URL for the health check that verifies whether the instance is healthy.
detailedHealthState

enum (HealthState)

Output only. The current detailed instance health state.

HealthState

Enums
UNKNOWN The health checking system is aware of the instance but its health is not known at the moment.
HEALTHY The instance is reachable i.e. a connection to the application health checking endpoint can be established, and conforms to the requirements defined by the health check.
UNHEALTHY The instance is reachable, but does not conform to the requirements defined by the health check.
DRAINING The instance is being drained. The existing connections to the instance have time to complete, but the new ones are being refused.
TIMEOUT The instance is unreachable i.e. a connection to the application health checking endpoint cannot be established, or the server does not respond within the specified timeout.

Scheduling

JSON representation 
{
  "terminationTimestamp": string,
  "gracefulShutdownTimestamp": string
}
Fields
terminationTimestamp

string (Timestamp format)

Output only. The timestamp at which the managed instance will be terminated. This is in RFC3339 text format.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
gracefulShutdownTimestamp

string (Timestamp format)

Output only. The timestamp at which the underlying instance will be triggered for graceful shutdown if it is configured. This is in RFC3339 text format.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

ShutdownDetails

JSON representation 
{
  "requestTimestamp": string,
  "maxDuration": {
    object (Duration)
  }
}
Fields
requestTimestamp

string (Timestamp format)

Output only. Past timestamp indicating the beginning of PENDING_STOP state of instance in RFC3339 text format.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
maxDuration

object (Duration)

Output only. The duration for graceful shutdown. Only applicable when the instance is in PENDING_STOP state.

LastAttempt

JSON representation 
{
  "errors": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string,
        "errorDetails": [
          {
            "errorInfo": {
              object (ErrorInfo)
            },
            "quotaInfo": {
              object (QuotaExceededInfo)
            },
            "help": {
              object (Help)
            },
            "localizedMessage": {
              object (LocalizedMessage)
            }
          }
        ]
      }
    ]
  }
}
Fields
errors

object

Output only. Encountered errors during the last attempt to create or delete the instance.
errors.errors[]

object

Output only. The array of errors encountered while processing this operation.
errors.errors[].code

string

Output only. The error type identifier for this error.
errors.errors[].location

string

Output only. Indicates the field in the request that caused the error. This property is optional.
errors.errors[].message

string

Output only. An optional, human-readable error message.
errors.errors[].errorDetails[]

object

Output only. An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
errors.errors[].errorDetails[].errorInfo

object (ErrorInfo)
errors.errors[].errorDetails[].quotaInfo

object (QuotaExceededInfo)
errors.errors[].errorDetails[].help

object (Help)
errors.errors[].errorDetails[].localizedMessage

object (LocalizedMessage)

PropertiesFromFlexibilityPolicy

JSON representation 
{
  "machineType": string
}
Fields
machineType

string

Output only. The machine type to be used for this instance.