REST Resource: projects.patchJobs.instanceDetails

Resource: PatchJobInstanceDetails

Patch details for a VM instance. For more information about reviewing VM instance details, seeListing all VM instance details for a specific patch job.

JSON representation
{"name":string,"instanceSystemId":string,"state":enum (`PatchState`),"failureReason":string,"attemptCount":string}

Fields
`name`	`string` The instance name in the form`projects//zones//instances/*`
`instanceSystemId`	`string` The unique identifier for the instance. This identifier is defined by the server.
`state`	`enum (PatchState)` Current state of instance patch.
`failureReason`	`string` If the patch fails, this field provides the reason.
`attemptCount`	`string (int64 format)` The number of times the agent that the agent attempts to apply the patch.

Patch state of an instance.

Enums
`PATCH_STATE_UNSPECIFIED`	Unspecified.
`PENDING`	The instance is not yet notified.
`INACTIVE`	Instance is inactive and cannot be patched.
`NOTIFIED`	The instance is notified that it should be patched.
`STARTED`	The instance has started the patching process.
`DOWNLOADING_PATCHES`	The instance is downloading patches.
`APPLYING_PATCHES`	The instance is applying patches.
`REBOOTING`	The instance is rebooting.
`SUCCEEDED`	The instance has completed applying patches.
`SUCCEEDED_REBOOT_REQUIRED`	The instance has completed applying patches but a reboot is required.
`FAILED`	The instance has failed to apply the patch.
`ACKED`	The instance acked the notification and will start shortly.
`TIMED_OUT`	The instance exceeded the time out while applying the patch.
`RUNNING_PRE_PATCH_STEP`	The instance is running the pre-patch step.
`RUNNING_POST_PATCH_STEP`	The instance is running the post-patch step.
`NO_AGENT_DETECTED`	The service could not detect the presence of the agent. Check to ensure that the agent is installed, running, and able to communicate with the service.
`SKIPPED`	The instance was skipped during patching due to one of two reasons: The instance runs Container-Optimized OS (COS), which cannot be patched. The patch job's configuration prohibits patching on Managed Instance Groups (MIGs), and the instance is part of one.

Methods
`list`	Get a list of instance details for a given patch job.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-11-17 UTC.