API Reference

この API リファレンスは、リソースタイプ別にまとめられています。リソースの各タイプには、1 つ以上のデータ表現と 1 つ以上のメソッドがあります。

リソースタイプ

  1. CompositeTypes
  2. Deployments
  3. マニフェスト
  4. オペレーション
  5. リソース
  6. TypeProviders
  7. タイプ

CompositeTypes

CompositeTypes リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/deploymentmanager/v2beta/projects を基準とします。
delete DELETE  /project/global/compositeTypes/compositeType 複合タイプを削除します。
get GET  /project/global/compositeTypes/compositeType 特定の複合型に関する情報を取得します。
insert POST  /project/global/compositeTypes 複合タイプを作成します。
list GET  /project/global/compositeTypes Deployment Manager のすべての複合タイプを一覧表示します。
patch PATCH  /project/global/compositeTypes/compositeType 複合タイプにパッチを適用します。
update PUT  /project/global/compositeTypes/compositeType 複合タイプを更新します。

デプロイ

デプロイ リソースについて詳しくは、リソースの表記ページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/deploymentmanager/v2beta/projects を基準とします。
cancelPreview POST  /project/global/deployments/deployment/cancelPreview デプロイに現在関連付けられているプレビューをキャンセルして削除します。
delete DELETE  /project/global/deployments/deployment デプロイとデプロイ内のすべてのリソースを削除します。
get GET  /project/global/deployments/deployment 特定のデプロイに関する情報を取得します。
getIamPolicy GET  /project/global/deployments/resource/getIamPolicy リソースのアクセス制御ポリシーを取得します。このようなポリシーまたはリソースが存在しない場合、空になります。
insert POST  /project/global/deployments デプロイの作成と、デプロイ マニフェストにより記述されているすべてのリソースの作成を行います。
list GET  /project/global/deployments 特定のプロジェクトのすべてのデプロイメントを一覧表示します。
patch PATCH  /project/global/deployments/deployment デプロイメントと、デプロイ マニフェストで記述されているすべてのリソースにパッチを適用します。
setIamPolicy POST  /project/global/deployments/resource/setIamPolicy 指定したリソースにアクセス制御ポリシーを設定します。既存のポリシーをすべて置き換えます。
stop POST  /project/global/deployments/deployment/stop 実行中のオペレーションを停止します。これにより、完了した作業はロールバックされませんが、新しい作業は開始されなくなります。
testIamPermissions POST  /project/global/deployments/resource/testIamPermissions 指定したリソースに対して呼び出し元が持っている権限を返します。
update PUT  /project/global/deployments/deployment デプロイと、そのデプロイ マニフェストにより記述されているすべてのリソースを更新します。

マニフェスト

マニフェスト リソースについて詳しくは、リソースの表記ページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/deploymentmanager/v2beta/projects を基準とします。
get GET  /project/global/deployments/deployment/manifests/manifest 特定のマニフェストに関する情報を取得します。
list GET  /project/global/deployments/deployment/manifests 特定のデプロイメントのすべてのマニフェストを一覧表示します。

オペレーション

オペレーション リソースの詳細については、リソースの表記ページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/deploymentmanager/v2beta/projects を基準とします。
get GET  /project/global/operations/operation 特定のオペレーションに関する情報を取得します。
list GET  /project/global/operations プロジェクトのすべてのオペレーションを一覧表示します。

リソース

リソース リソースについて詳しくは、リソースの表記ページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/deploymentmanager/v2beta/projects を基準とします。
get GET  /project/global/deployments/deployment/resources/resource 単一のリソースに関する情報を取得します。
list GET  /project/global/deployments/deployment/resources 特定のデプロイ内のすべてのリソースを一覧表示します。

TypeProviders

TypeProviders リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/deploymentmanager/v2beta/projects を基準とします。
delete DELETE  /project/global/typeProviders/typeProvider タイプ プロバイダを削除します。
get GET  /project/global/typeProviders/typeProvider 特定の型プロバイダに関する情報を取得します。
getType GET  /project/global/typeProviders/typeProvider/types/type TypeProvider によって提供されるタイプのタイプ情報を取得します。
insert POST  /project/global/typeProviders タイプ プロバイダを作成します。
list GET  /project/global/typeProviders Deployment Manager のすべてのリソースタイプ プロバイダを一覧表示します。
listTypes GET  /project/global/typeProviders/typeProvider/types TypeProvider のすべての型情報を一覧表示します。
patch PATCH  /project/global/typeProviders/typeProvider タイプ プロバイダにパッチを適用します。
update PUT  /project/global/typeProviders/typeProvider 型プロバイダを更新します。

タイプ

タイプリソースについて詳しくは、リソースの表記ページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/deploymentmanager/v2beta/projects を基準とします。
list GET  /project/global/types Deployment Manager のすべてのリソースタイプを一覧表示します。