Deployments

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

デプロイは、設定ファイルを使用して、まとめてデプロイ、管理されるリソースの集合です。

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

リソースの表記



{
  "id": unsigned long,
  "insertTime": string,
  "updateTime": string,
  "name": string,
  "description": string,
  "fingerprint": bytes,
  "manifest": string,
  "update": {
    "errors": [
      string
    ],
    "manifest": string
  },
  "target": {
    "config": string,
    "imports": [
      {
        "name": string,
        "content": string
      }
    ]
  },
  "state": string,
  "intent": string
}
プロパティ名 値 説明 メモ
description string ユーザーによるデプロイの説明。省略可。
fingerprint bytes update() リクエストのフィンガープリントを指定します。フィンガープリントは、楽観的ロックを実行するために update() リクエストで指定する必要があるランダムに生成された値です。これは楽観的並行性を保証し、一度に 1 つの更新だけが行われるようにします。フィンガープリントは最初に Deployment Manager により生成され、その後データを変更するリクエストが発生するたびに更新されます。最新のフィンガープリント値を取得するには、デプロイメントに対して get() リクエストを実行します。
id unsigned long [出力専用] リソースの一意の識別子（サーバーにより設定される）。
insertTime string [出力のみ] デプロイメントが作成されたときのタイムスタンプ（RFC3339 テキスト形式）。
intent string [入力専用] Deployment Manager がこのテンプレートを適用する方法を指定します。指定可能な選択肢は PREVIEW、UPDATE、CANCEL です。

PREVIEW はデプロイメントを作成し、「シェル」リソースを作成しますが、これらのリソースは実際にはインスタンス化されません。これにより、デプロイの内容をプレビューして事前に確認することができます。このインテントを使用することで、デプロイに対する更新や新規のデプロイをプレビューできます。このインテントの構成を含む target.config を指定する必要があります。デプロイをプレビューした後、UPDATE インテントを使用してリクエストを送信してリソースをデプロイできます。また、プレビュー全体を CANCEL することもできます。プレビューをキャンセルしてもデプロイがなくならないことにご注意ください。デプロイを削除するには別途削除の操作が必要です。

UPDATE は、デプロイメント内の基盤となるリソースの更新を実行します。このリクエストで入力済みの target.config フィールドを指定した場合は、Deployment Manager はその構成を使用して更新を実行します。事前にこの更新をプレビューしていて、target.config を指定しなかった場合、または空の target.config を指定した場合は、Deployment Manager は最後にプレビューした構成を使用します。

CANCEL は、PREVIEW または UPDATE にある更新をキャンセルしますが、すでに行われた変更は取り消しません。
manifest string [出力専用] 正常にデプロイされた最後のマニフェストを表すマニフェストの URL。
name string リソースの作成時にクライアントが指定するリソースの名前。名前は 1 ～ 63 文字で、RFC1035 に準拠している必要があります。具体的には、名前は 1 ～ 63 文字で、正規表現 [a-z]([-a-z0-9]*[a-z0-9])? と一致している必要があります。つまり、先頭文字には小文字を使用し、残りの文字にはダッシュ、小文字、数字を使用する必要があります。ただし最後の文字にはダッシュを使用できません。
state string [出力専用] デプロイの現在の状態。取り得る値は、DEPLOYED、DEPLOYMENT_FAILED、PREVIEWING、UPDATING、CANCELING です。
target nested object [入力専用] デプロイを定義するパラメータ。デプロイの設定とそれに関連するテンプレートが含まれます。
target.config string このデプロイのために使用する設定。
target.imports[] list この設定のためにインポートするすべてのファイル。テンプレートや他のファイルをインポートするために使用されます。たとえば、テキスト ファイルをインポートしてテンプレート内で使用する場合があります。
target.imports[].content string ファイルの内容。
target.imports[].name string ファイルの名前。
update nested object [出力専用] Deployment Manager がこのデプロイを更新している場合、またはこのデプロイの更新をプレビューしている場合は、更新後の設定がここに表示されます。
update.errors[] list [出力専用] 更新を確定しようとしたときに発生したすべてのエラーのリスト。
update.manifest string [出力専用] デプロイの更新後の設定を示すマニフェストの URL。
updateTime string [出力のみ] デプロイメントが更新されたときのタイムスタンプ（RFC3339 テキスト形式）。

メソッド

delete
デプロイとデプロイ内のすべてのリソースを削除します。
get
特定のデプロイに関する情報を取得します。
insert
デプロイメントと、Deployment マニフェストで記述されているすべてのリソースを作成します。
list
指定されたプロジェクトのすべてのデプロイメントを一覧表示します。
patch
デプロイメントと、デプロイ マニフェストで記述されているすべてのリソースを更新します。このメソッドはパッチのセマンティクスをサポートしています。
update
デプロイメントと、デプロイ マニフェストで記述されているすべてのリソースを更新します。