REST リソース: projects.patchJobs

リソース: PatchJob

進行中または完了したパッチジョブの表現の概要。

インスタンスの詳細はこのジョブに含まれません。インスタンスの詳細からページを設定するには、instanceDetails.list を使用します。

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
    }
フィールド
name

string

このパッチジョブの一意の識別子(projects/*/patchJobs/* 形式)

displayName

string

このパッチジョブの表示名。これは一意の識別子ではありません。

description

string

パッチジョブの説明。説明の長さは 1,024 文字までに制限されています。

createTime

Timestampstring ( format)

このパッチジョブが作成された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"

updateTime

Timestampstring ( format)

このパッチジョブが最後に更新された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"

state

Stateenum ()

PatchJob の現在の状態。

instanceFilter

PatchInstanceFilterobject ()

パッチを適用するインスタンス。

patchConfig

PatchConfigobject ()

パッチ構成が適用されています。

duration

Durationstring ( format)

パッチジョブの期間。期間が終了すると、パッチジョブがタイムアウトします。

小数 9 桁まで、「s」で終わる秒単位の期間(例: "3.5s")。

instanceDetailsSummary

InstanceDetailsSummaryobject ()

インスタンスの詳細の概要。

dryRun

boolean

このパッチジョブがドライランの場合、エージェントは VM インスタンスに対して更新を実行せずに終了したことを報告します。

errorMessage

string

このパッチジョブが失敗した場合、このメッセージで失敗に関する情報が提供されます。

percentComplete

number

パッチジョブの全体的な進行状況を、0.0 の進捗なしから 100.0 の完了までの範囲で反映します。

patchDeployment

string

出力のみ。このパッチジョブを作成したパッチデプロイの名前。

状態

パッチジョブの実行過程におけるさまざまな状態の列挙。

列挙型
STATE_UNSPECIFIED 状態を指定する必要があります。
STARTED パッチジョブが正常に開始されました。
INSTANCE_LOOKUP パッチジョブはパッチを実行するインスタンスを検索しています。
PATCHING インスタンスにパッチが適用されています。
SUCCEEDED パッチジョブが正常に完了しました。
COMPLETED_WITH_ERRORS パッチジョブは完了しましたが、エラーが発生しました。
CANCELED パッチジョブはキャンセルされました。
TIMED_OUT パッチジョブがタイムアウトしました。

InstanceDetailsSummary

このパッチジョブが影響するすべてのインスタンスの現在のパッチ状態の概要。さまざまな状態の多数のインスタンスが含まれます。この状態は InstancePatchState に対応しています。パッチジョブのインスタンスの詳細を一覧表示して、各インスタンスの固有の状態を確認します。

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
    }
フィールド
pendingInstanceCount

string (int64 format)

パッチジョブを保留しているインスタンスの数。

inactiveInstanceCount

string (int64 format)

非アクティブなインスタンスの数。

notifiedInstanceCount

string (int64 format)

パッチジョブに関する通知を受け取ったインスタンスの数。

startedInstanceCount

string (int64 format)

開始したインスタンスの数。

downloadingPatchesInstanceCount

string (int64 format)

パッチをダウンロードしているインスタンスの数。

applyingPatchesInstanceCount

string (int64 format)

パッチを適用しているインスタンスの数。

rebootingInstanceCount

string (int64 format)

再起動中のインスタンスの数。

succeededInstanceCount

string (int64 format)

正常に完了したインスタンスの数。

succeededRebootRequiredInstanceCount

string (int64 format)

再起動が必要なインスタンスの数。

failedInstanceCount

string (int64 format)

失敗したインスタンスの数。

ackedInstanceCount

string (int64 format)

確認応答済みでまもなく開始されるインスタンスの数。

timedOutInstanceCount

string (int64 format)

パッチ適用中にタイムアウトを超過したインスタンスの数。

prePatchStepInstanceCount

string (int64 format)

パッチ前のステップを実行しているインスタンスの数。

postPatchStepInstanceCount

string (int64 format)

パッチ後のステップを実行しているインスタンスの数。

noAgentDetectedInstanceCount

string (int64 format)

エージェントが実行されていない可能性のあるインスタンスの数。エージェントがインストール済みかつ実行中であり、サービスと通信できることを確認します。

メソッド

cancel

パッチジョブをキャンセルします。

execute

パッチジョブを作成、実行して、VM インスタンスにパッチを適用します。

get

パッチジョブを取得します。

list

パッチジョブのリストを取得します。