デプロイ: cancelPreview

承認が必要

現在デプロイに関連付けられているプレビューをキャンセルして削除します。

サンプルコードを参照してください。

今すぐお試しください。

サンプルコードを参照してください。
今すぐお試しください。

リクエスト

HTTP リクエスト

POST https://www.googleapis.com/deploymentmanager/v2/projects/project/global/deployments/deployment/cancelPreview

パラメータ

パラメータ名	値	説明
パスパラメータ
`deployment`	`string`	このリクエストのデプロイ名。
`project`	`string`	このリクエストのプロジェクト ID。

承認

このリクエストには、次の 1 つ以上のスコープの承認が必要です（認証と承認についてはこちらをご覧ください）。

スコープ
`https://www.googleapis.com/auth/cloud-platform`
`https://www.googleapis.com/auth/ndev.cloudman`

リクエストの本文

リクエストの本文には、以下の構造を使用してデータを指定してください:

{
  "fingerprint": bytes
}

プロパティ名	値	説明	メモ
`fingerprint`	`bytes`	`cancelPreview()` リクエストのフィンガープリントを指定します。フィンガープリントは楽観的ロックを実行するための、`cancelPreview()` リクエストに含まれる必須のプロパティであり、ランダムに生成された値です。フィンガープリントにより楽観的同時実行が保証されるため、デプロイには競合するリクエストが発生しません（たとえば、他のユーザーがプレビューをキャンセルしようとしているときに誰かが新しい更新リクエストを実行しようとすると、どちらかのリクエストが止められます）。フィンガープリントは最初に Deployment Manager により生成され、その後デプロイを変更するリクエストが発生するたびに更新されます。最新のフィンガープリントの値を取得するには、デプロイに対して `get()` リクエストを実行してください。

レスポンス

成功すると、このメソッドによって次の構造を含むレスポンスの本文が返されます。

{
  "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
}

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