API一覧#

 

Show build information#

項番 API名 処理概要
1 GET /v1/{tenant_id}/build_info
Show build information		 ビルド情報を表示する 

Stacks#

項番 API名 処理概要
1 POST /v1/{tenant_id}/stacks
Create stack		 スタックを作成する
2 POST /v1/{tenant_id}/stacks/preview
Preview stack		 スタックをプレビューする
3 GET /v1/{tenant_id}/stacks
List stacks		 スタックを一覧表示する
4 GET /v1/{tenant_id}/stacks/{stack_identity}
Find stack		 スタックを検索する
5 GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}
Show stack details		 スタックの詳細を表示する
6 PUT /v1/{tenant_id}/stacks/{stack_name}/{stack_id}
Update stack		 スタックを更新する
7 PATCH /v1/{tenant_id}/stacks/{stack_name}/{stack_id}
Update stack (PATCH)		 スタックを部分的に更新する
8 PUT /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/preview
Preview stack update		 スタックの更新をプレビューする
9 PATCH /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/preview
Preview stack update (PATCH)		 スタックの部分的な更新をプレビューする
10 DELETE /v1/{tenant_id}/stacks/{stack_identity}
Find stack for deletion		 削除するスタックを検索する
11 DELETE /v1/{tenant_id}/stacks/{stack_name}/{stack_id}
Delete stack		 スタックを削除する
12 DELETE /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/abandon
Abandon stack		 スタックを廃棄する(スタック内リソースは削除しない)
13 GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/export
Export stack		 スタックをエクスポートする
14 GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/template
Get stack template		 スタックのテンプレートを表示する
15 GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/environment
Get stack environment		 スタックの環境を表示する
16 GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/files
Get stack files		 スタックのファイルを表示する 

Stack Resources#

項番 API名 処理概要
1 GET /v1/{tenant_id}/stacks/{stack_identity}/resources
Find stack resources		 スタックのリソースを検索する
2 GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources
List stack resources		 スタックのリソースを一覧表示する
3 GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}
Show resource data		 リソースデータを表示する
4 GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/metadata
Show resource metadata		 リソースのメタデータを表示する
5 POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/signal
Send a signal to a resource		 リソースにシグナルを送信する
6 PATCH /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name_or_physical_id}
Mark a resource as unhealthy		 指定したリソースのステータスを更新する 

Stack Outputs#

項番 API名 処理概要
1 GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/outputs
List outputs		 スタックの出力を一覧表示する
2 GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/outputs/{output_key}
Show output		 スタックの出力を表示する 

Stack Snapshots#

項番 API名 処理概要
1 POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/snapshots
Snapshot a stack		 スタックのスナップショットを作成する
2 GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/snapshots
List snapshots		 スタックのスナップショットを一覧表示する
3 GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/snapshots/{snapshot_id}
Show snapshot		 スタックのスナップショットを表示する
4 POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/snapshots/{snapshot_id}/restore
Restore snapshot		 スタックのスナップショットをリストアする
5 DELETE /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/snapshots/{snapshot_id}
Delete a snapshot		 スタックのスナップショットを削除する 

Stack Actions#

項番 API名 処理概要
1 POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/actions
Suspend stack		 スタックを一時停止する
2 POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/actions
Resume stack		 スタックの一時停止を再開する
3 POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/actions
Cancel stack update		 スタックの更新を取り消す
4 POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/actions
Cancel stack create/update without rollback		 スタックの作成/更新を取り消す(ロールバックなし)
5 POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/actions
Check stack resources		 スタックのリソースを確認する 

Events#

項番 API名 処理概要
1 GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/events
List stack events		 指定したスタックのイベントを一覧表示する
2 GET /v1/{tenant_id}/stacks/{stack_name}/events
Find stack events		 指定したスタックのイベントリストのcanonical属性を指定したURLを探す
3 GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/events
List resource events		 リソースイベントを一覧表示する
4 GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/events/{event_id}
Show event details		 イベントの詳細を表示する 

Templates#

項番 API名 処理概要
1 GET /v1/{tenant_id}/template_versions
List template versions		 テンプレートのバージョンを一覧表示する
2 GET /v1/{tenant_id}/template_versions/{template_version}/functions
List template functions		 テンプレート機能を一覧表示する
3 POST /v1/{tenant_id}/validate
Validate template		 テンプレートを検証する 

Software Configuration#

項番 API名 処理概要
1 POST /v1/{tenant_id}/software_configs
Create configuration		 ソフトウェアの設定を作成する
2 GET /v1/{tenant_id}/software_configs List configs ソフトウェア設定を一覧表示する
3 GET /v1/{tenant_id}/software_configs/{config_id}
Show configuration details		 ソフトウェア設定の詳細を表示する
4 DELETE /v1/{tenant_id}/software_configs/{config_id}
Delete config		 ソフトウェア設定を削除する
5 POST /v1/{tenant_id}/software_deployments
Create deployment		 ソフトウェアデプロイメントを作成する
6 GET /v1/{tenant_id}/software_deployments
List deployments		 ソフトウェアデプロイメントを一覧表示する
7 GET /v1/{tenant_id}/software_deployments/{deployment_id}
Show deployment details		 ソフトウェアデプロイメントの詳細を表示する
8 PUT /v1/{tenant_id}/software_deployments/{deployment_id}
Update deployment		 ソフトウェアデプロイメントを更新する
9 DELETE /v1/{tenant_id}/software_deployments/{deployment_id}
Delete deployment		 ソフトウェアデプロイメントを削除する
10 GET /v1/{tenant_id}/software_deployments/metadata/{server_id}
Show server configuration metadata		 サーバのデプロイメント設定メタデータを表示する 

Resource Types#

項番 API名 処理概要
1 GET /v1/{tenant_id}/resource_types
List resource types		 利用可能なテンプレートリソースタイプを一覧表示する
2 GET /v1/{tenant_id}/resource_types/{type_name}/template
Show resource type template		 リソースタイプのテンプレートを表示する
3 GET /v1/{tenant_id}/resource_types/{type_name}
Show resource type schema		 リソースタイプのインタフェーススキーマを表示する
4 GET /v1/{tenant_id}/services
Show orchestration engine status		 オーケストレーションエンジンのステータスを一覧表示する