Recurso de REST: projects.patchJobs

Recurso: PatchJob

Representación de alto nivel de un trabajo de aplicación de parche que está en curso o ya se completó.

Los detalles de las instancias no se incluyen en el trabajo. Para paginar los detalles de la instancia, usa instanceDetails.list.

Para obtener más información sobre los trabajos de aplicación de parches, consulta Crea trabajos de aplicación de parches.

Representación JSON

{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "instanceFilter": {
    object (PatchInstanceFilter)
  },
  "patchConfig": {
    object (PatchConfig)
  },
  "duration": string,
  "instanceDetailsSummary": {
    object (InstanceDetailsSummary)
  },
  "dryRun": boolean,
  "errorMessage": string,
  "percentComplete": number,
  "patchDeployment": string
}
Campos
name

string

Identificador único para este trabajo de aplicación de parche con el formato projects/*/patchJobs/*.

displayName

string

Nombre de visualización de este trabajo de aplicación de parche. Este no es un identificador único.

description

string

Descripción del trabajo de aplicación de parche. El largo de la descripción se limita a 1,024 caracteres.

createTime

string (Timestamp format)

Hora en la que se creó este trabajo de aplicación de parche.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con precisión de nanosegundos. Ejemplo: "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Última vez que se actualizó este trabajo de parche.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con precisión de nanosegundos. Ejemplo: "2014-10-02T15:01:23.045123456Z".

state

enum (State)

El estado actual de PatchJob.

instanceFilter

object (PatchInstanceFilter)

Instancias a las que se aplicarán los parches.

patchConfig

object (PatchConfig)

Se está aplicando la configuración del parche.

duration

string (Duration format)

Duración del trabajo de aplicación de parche. Cuando finaliza la duración, se agota el tiempo de espera del trabajo de aplicación de parche.

Una duración en segundos con hasta nueve dígitos decimales, terminados en “s”. Ejemplo: "3.5s".

instanceDetailsSummary

object (InstanceDetailsSummary)

Resumen de los detalles de la instancia.

dryRun

boolean

Si este trabajo de aplicación de parche es una ejecución de prueba, el agente informará que finalizó sin ejecutar ninguna actualización en la instancia de VM.

errorMessage

string

Si este trabajo de aplicación parche falla, este mensaje proporciona información sobre el error.

percentComplete

number

Refleja el progreso general del trabajo de aplicación de parche en el rango de 0.0 (sin progreso) a 100.0 (completo).

patchDeployment

string

Solo salida. Nombre de la implementación de parche que creó este trabajo de aplicación de parche.

Estado

Enumeración de los diferentes estados por los que pasa un trabajo aplicación de parche mientras se ejecuta.

Enumeraciones
STATE_UNSPECIFIED Se debe especificar el estado.
STARTED El trabajo de aplicación de parche se inició de forma correcta.
INSTANCE_LOOKUP El trabajo de aplicación de parche busca instancias para ejecutar el parche.
PATCHING Se están aplicando parches a las instancias.
SUCCEEDED El trabajo de parche se completó de forma correcta.
COMPLETED_WITH_ERRORS Se completó el trabajo de aplicación de parche, pero se produjeron errores.
CANCELED Se canceló el trabajo de aplicación de parche.
TIMED_OUT Se agotó el tiempo de espera del trabajo de aplicación de parche.

InstanceDetailsSummary

Un resumen del estado actual del parche en todas las instancias a las que afecta este trabajo de parche. Contiene recuentos de instancias en diferentes estados. Estos estados se asignan a InstancePatchState. Enumera los detalles de la instancia de trabajo de aplicación de parche para ver los estados específicos de cada instancia.

Representación JSON

{
  "pendingInstanceCount": string,
  "inactiveInstanceCount": string,
  "notifiedInstanceCount": string,
  "startedInstanceCount": string,
  "downloadingPatchesInstanceCount": string,
  "applyingPatchesInstanceCount": string,
  "rebootingInstanceCount": string,
  "succeededInstanceCount": string,
  "succeededRebootRequiredInstanceCount": string,
  "failedInstanceCount": string,
  "ackedInstanceCount": string,
  "timedOutInstanceCount": string,
  "prePatchStepInstanceCount": string,
  "postPatchStepInstanceCount": string,
  "noAgentDetectedInstanceCount": string
}
Campos
pendingInstanceCount

string (int64 format)

Cantidad de instancias pendientes de un trabajo de aplicación de parche.

inactiveInstanceCount

string (int64 format)

Cantidad de instancias que están inactivas.

notifiedInstanceCount

string (int64 format)

Cantidad de instancias notificadas sobre el trabajo de aplicación de parche.

startedInstanceCount

string (int64 format)

Cantidad de instancias que se iniciaron.

downloadingPatchesInstanceCount

string (int64 format)

Cantidad de instancias que están descargando parches.

applyingPatchesInstanceCount

string (int64 format)

Cantidad de instancias que están aplicando parches.

rebootingInstanceCount

string (int64 format)

Cantidad de instancias que se están reiniciando.

succeededInstanceCount

string (int64 format)

Cantidad de instancias que se completaron de forma correcta.

succeededRebootRequiredInstanceCount

string (int64 format)

Cantidad de instancias que requieren reinicio.

failedInstanceCount

string (int64 format)

Cantidad de instancias que fallaron.

ackedInstanceCount

string (int64 format)

Cantidad de instancias que se confirmaron y comenzarán en breve.

timedOutInstanceCount

string (int64 format)

Cantidad de instancias que agotaron el tiempo de espera mientras se aplicaba el parche.

prePatchStepInstanceCount

string (int64 format)

Cantidad de instancias que ejecutan el paso previo a la aplicación del parche.

postPatchStepInstanceCount

string (int64 format)

Cantidad de instancias que ejecutan el paso posterior a la aplicación del parche.

noAgentDetectedInstanceCount

string (int64 format)

Cantidad de instancias que no parecen estar ejecutando el agente. Verifica que el agente esté instalado, se esté ejecutando y pueda comunicarse con el servicio.

Métodos

cancel

Cancela un trabajo de aplicación de parches.

execute

Aplica parches a las instancias de VM mediante la creación y ejecución de un trabajo de aplicación de parche.

get

Obtén el trabajo de aplicación de parches.

list

Obtén una lista de trabajos de aplicación de parches.