オペレーション

オペレーションは、データを変更するすべてのリクエストのステータスを追跡します。リソースを変化させるリクエストそれぞれに対して、オペレーションが返されます。

このリソースのメソッドのリストについては、このページの末尾をご覧ください。

リソースの表記

オペレーションリソース（非同期 API リクエストの管理に使用）。

{
  "kind": "deploymentmanager#operation",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": unsigned long,
  "status": string,
  "statusMessage": string,
  "user": string,
  "progress": integer,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string
      }
    ]
  },
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": integer,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string
}

プロパティ名	値	説明
`clientOperationId`	`string`	[出力専用] 将来の使用のために予約。
`creationTimestamp`	`string`	[出力専用] 作成日時のタイムスタンプ（RFC3339 テキスト形式）。
`description`	`string`	[出力専用] オペレーションに関するテキスト形式の説明。オペレーションが作成されたときに設定されます。
`endTime`	`string`	[出力専用] このオペレーションが完了した時刻。値は RFC3339 テキスト形式です。
`error`	`object`	[出力専用] オペレーションの処理中にエラーが発生した場合に、このフィールドにデータが入力されます。
`error.errors[]`	`list`	[出力専用] オペレーションの処理中に発生したエラーを格納した配列。
`error.errors[].code`	`string`	[出力専用] このエラーのタイプを示す識別子。
`error.errors[].location`	`string`	[出力専用] リクエスト内の、エラーが発生したフィールドを示します。このプロパティは省略可能です。
`error.errors[].message`	`string`	[出力専用] 人が読める形式のエラーメッセージ（省略可）。
`httpErrorMessage`	`string`	[出力専用] オペレーションが失敗した場合に、返された HTTP エラーメッセージ（`NOT FOUND` など）がこのフィールドに入力されます。
`httpErrorStatusCode`	`integer`	[出力専用] オペレーションが失敗した場合に、返された HTTP エラーステータスコードがこのフィールドに入力されます。たとえば、`404` はリソースが見つからなかったことを示します。
`id`	`unsigned long`	[出力専用] 一意のリソース識別子。この識別子はサーバーによって定義されます。
`insertTime`	`string`	[出力専用] このオペレーションがリクエストされた時刻。値は RFC3339 テキスト形式です。
`kind`	`string`	[出力専用] リソースのタイプ。オペレーションリソースは常に `compute#operation` です。
`name`	`string`	[出力専用] リソースの名前。
`operationType`	`string`	[出力専用] オペレーションのタイプ。`insert`、`update`、`delete` など。
`progress`	`integer`	[出力専用] 0～100 の範囲で進捗を表示するインジケーター（省略可）。この値は線形である保証はなく、オペレーションの粒度にも対応していません。オペレーションの完了時刻の予想には使用できません。この数値はオペレーションの進捗に応じて単調に増加します。
`region`	`string`	[出力専用] オペレーションが存在する地域の URL。ゾーンごとのオペレーションを実行するときのみ使用できます。
`selfLink`	`string`	[出力専用] サーバーがリソースに設定した URL。
`startTime`	`string`	[出力専用] サーバーがこのオペレーションを開始した時刻。値は RFC3339 テキスト形式です。
`status`	`string`	[出力専用] オペレーションのステータス。取り得る値は、`PENDING`、`RUNNING`、`DONE` です。
`statusMessage`	`string`	[出力専用] オペレーションの現在のステータスを説明するテキスト（省略可）。
`targetId`	`unsigned long`	[出力専用] 具体的なターゲットリソースを識別する一意のターゲット ID。
`targetLink`	`string`	[出力専用] オペレーションにより変更されるリソースの URL。スナップショットの作成に関連するオペレーションでは、スナップショットの作成元の永続ディスクを示します。
`user`	`string`	[出力専用] オペレーションをリクエストしたユーザー（例: `user@example.com`）。
`warnings[]`	`list`	[出力専用] オペレーションの処理中に警告メッセージが生成された場合に、このフィールドにデータが入力されます。
`warnings[].code`	`string`	[出力専用] 警告コード。該当する場合に使用されます。たとえばレスポンスに結果がない場合に Compute Engine は `NO_RESULTS_ON_PAGE` を返します。
`warnings[].data[]`	`list`	[出力専用] この警告のメタデータ（`key: value` 形式）。例: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`warnings[].data[].key`	`string`	[出力専用] 返された警告の詳細を示すキー。たとえば、特定のゾーンに関するリストリクエストに結果がない場合の警告に対しては、このキーが `scope` になりキーの値はゾーン名になることが考えられます。その他の例としては、サポートが終了したリソースと推奨される代替リソース、あるいは、誤ったネットワーク設定に関する警告（たとえば、インスタンスが IP 転送を試みたが IP 転送が有効になっていない）を表すキーが考えられます。
`warnings[].data[].value`	`string`	[出力専用] キーに対応する警告データ値。
`warnings[].message`	`string`	[出力専用] 警告コードに関する、人が読める形式の説明。
`zone`	`string`	[出力専用] オペレーションが存在するゾーンの URL。ゾーンごとのオペレーションを実行するときのみ使用できます。

メソッド

get: 特定のオペレーションに関する情報を取得します。
list: プロジェクトのすべてのオペレーションに関するリストを取得します。