Recurso REST: projects.patchJobs

Recurso: PatchJob

Uma representação de alto nível de um job de patch em andamento ou concluído.

Os detalhes das instâncias não são incluídos no job. Para ver as páginas dos detalhes da instância, use instanceDetails.list.

Para mais informações sobre jobs de patch, consulte Como criar jobs de patch.

Representação 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 exclusivo deste job de patch na forma projects/*/patchJobs/*

displayName

string

Nome de exibição deste job de patch. Este não é um identificador exclusivo.

description

string

Descrição do job de patch. O tamanho da descrição é limitado a 1.024 caracteres.

createTime

string (Timestamp format)

Horário em que este job de patch foi criado.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Última vez em que este job de patch foi atualizado.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".

state

enum (State)

O estado atual do PatchJob.

instanceFilter

object (PatchInstanceFilter)

Instâncias que terão patch aplicado.

patchConfig

object (PatchConfig)

Configuração de patch sendo aplicada.

duration

string (Duration format)

Duração do job de patch. Depois que a duração terminar, o tempo de espera do job de patch expirará.

Uma duração em segundos com até nove dígitos fracionários, encerrada por "s". Exemplo: "3.5s".

instanceDetailsSummary

object (InstanceDetailsSummary)

Resumo dos detalhes da instância.

dryRun

boolean

Se esse job de patch for uma simulação, o agente informará que ele foi concluído sem executar nenhuma atualização na instância de VM.

errorMessage

string

Se este job de patch falhar, esta mensagem fornecerá informações sobre a falha.

percentComplete

number

Reflete o progresso geral do job de patch na faixa de 0 a 100, que indicam "sem progresso" e "completo" respectivamente.

patchDeployment

string

Apenas saída. Nome da implantação do patch que criou este job de patch.

Estado

Enumeração dos vários estados que um job de patch passa enquanto é executado.

Enums
STATE_UNSPECIFIED O estado precisa ser especificado.
STARTED O job de patch foi iniciado com sucesso.
INSTANCE_LOOKUP O job de patch procura instâncias para executar o patch.
PATCHING Os patches estão sendo aplicados nas instâncias.
SUCCEEDED O job de patch foi concluído com sucesso.
COMPLETED_WITH_ERRORS O job de patch foi concluído, mas houve erros.
CANCELED O job de patch foi cancelado.
TIMED_OUT O tempo de espera do job de patch foi atingido.

InstanceDetailsSummary

Um resumo do estado atual do patch em todas as instâncias afetadas por esse job de patch. Inclui contagens de instâncias em estados diferentes. Esses estados mapeiam para InstancePatchState. Liste os detalhes da instância do job de patch para ver os estados específicos de cada instância.

Representação 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)

Número de instâncias aguardando job de patch.

inactiveInstanceCount

string (int64 format)

Número de instâncias inativas.

notifiedInstanceCount

string (int64 format)

Número de instâncias notificadas sobre o job de patch.

startedInstanceCount

string (int64 format)

Número de instâncias iniciadas.

downloadingPatchesInstanceCount

string (int64 format)

Número de instâncias que estão fazendo o download de patches.

applyingPatchesInstanceCount

string (int64 format)

Número de instâncias que estão aplicando patches.

rebootingInstanceCount

string (int64 format)

Número de instâncias que estão reiniciando.

succeededInstanceCount

string (int64 format)

Número de instâncias concluídas com sucesso.

succeededRebootRequiredInstanceCount

string (int64 format)

Número de instâncias que exigem reinicialização.

failedInstanceCount

string (int64 format)

Número de instâncias que falharam.

ackedInstanceCount

string (int64 format)

Número de instâncias que foram confirmadas e serão iniciadas em breve.

timedOutInstanceCount

string (int64 format)

Número de instâncias que excederam o tempo limite ao aplicar o patch.

prePatchStepInstanceCount

string (int64 format)

Número de instâncias que estão executando a etapa de pré-patch.

postPatchStepInstanceCount

string (int64 format)

Número de instâncias que estão executando a etapa pós-patch.

noAgentDetectedInstanceCount

string (int64 format)

Número de instâncias que aparentemente não executam o agente. Verifique se o agente está instalado, em execução e capaz de se comunicar com o serviço.

Métodos

cancel

Cancele um job de patch.

execute

Corrija instâncias de VMs criando e executando um job de patch.

get

Receba o job de patch.

list

Receba uma lista de jobs de patch.