Deployments: patch

注意: これは Deployment Manager API の非推奨バージョンです。代わりに、最新の API バージョンを使用してください。

認証が必要です

デプロイと、デプロイ マニフェストで記述されているすべてのリソースを更新します。このメソッドは、パッチの動作をサポートします。 今すぐお試しください。

リクエスト

HTTP リクエスト

PATCH https://www.googleapis.com/deploymentmanager/v2beta2/projects/project/global/deployments/deployment

パラメータ

パラメータ名 値 説明
パスパラメータ
deployment string このリクエストのデプロイ名。
project string このリクエストのプロジェクト ID。
省略可能なクエリ パラメータ
createPolicy string 新しいリソースの作成に使用するポリシーを設定します。

有効な値は次のとおりです。
  • "ACQUIRE": 既存のリソースを取得します。リソースが存在しない場合、デプロイは失敗します。
  • 「CREATE_OR_ACQUIRE」: リソースが存在する場合は取得し、存在しない場合は作成します。（デフォルト）
deletePolicy string リソースの削除に使用するポリシーを設定します。

有効な値は次のとおりです。
  • 「ABANDON」: Deployment Manager からリソースを削除しますが、基盤となるリソースは削除しません。
  • 「DELETE」: Deployment Manager からリソースを削除し、基盤となるリソースを削除します。（デフォルト）
updatePolicy string リソースの更新に使用するポリシーを設定します。

有効な値は次のとおりです。
  • "PATCH": 既存のリソース上で部分更新のフィールドを行います。1 つのプロパティのみを更新する必要がある場合は、パッチ リクエストを実行します。（デフォルト）
  • 「UPDATE」: 既存のリソースに対して完全な更新リクエストを実行します。

承認

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

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

リクエストの本文

リクエスト本文にパッチ セマンティックのルールに基づいてデプロイ リソースの関連部分を設定してください。

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "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 など）。
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 など）がこのフィールドに示されます。
region string [出力専用] 操作が実行された地域の URL。地域の操作を実行するときのみ使用できます。
description string [出力専用] オペレーションに関するテキスト形式の説明。オペレーションが作成されたときに設定されます。