Api MCP Server

🚀 仮想マシン管理APIドキュメント

このAPIドキュメントは、仮想マシンの管理に関する各種操作を行うためのAPIについて説明しています。

📚 詳細ドキュメント

1. 仮想マシンの状態を取得する

インターフェースアドレス: /api/vps/v1/virtual-machines/{virtualMachineId}
リクエスト方式: GET

パラメータ:

• virtualMachineId: 仮想マシンID（必須）

説明:
このインターフェースは、指定された仮想マシンの詳細情報（稼働状態、設定、リソース使用状況など）を取得するために使用されます。

2. 新しい仮想マシンを作成する

インターフェースアドレス: /api/vps/v1/virtual-machines
リクエスト方式: POST

パラメータ:

• template_id: テンプレートID（必須）
• data_center_id: データセンターID（必須）
• post_install_script_id: 事後インストールスクリプトID
• password: 仮想マシンのパスワード。指定されない場合はランダムなパスワードが自動生成されます。
• hostname: カスタムホスト名
• install_monarx: Monarxマルウェアスキャナーをインストールするかどうか（サポートされている場合）
• enable_backups: 毎週のバックアップ計画を有効にするかどうか

説明:
このインターフェースは、新しい仮想マシンインスタンスを作成するために使用されます。パラメータには、テンプレートの選択、データセンターの位置、スクリプトの設定などが含まれます。

3. 仮想マシンの情報を更新する

インターフェースアドレス: /api/vps/v1/virtual-machines/{virtualMachineId}
リクエスト方式: PUT

パラメータ:

• virtualMachineId: 仮想マシンID（必須）
• hostname: 新しいホスト名
• template_id: 新しいテンプレートID
• data_center_id: 新しいデータセンターID
• post_install_script_id: 新しい事後インストールスクリプトID
• password: 新しいパスワード

説明:
このインターフェースは、指定された仮想マシンの情報（ホスト名、テンプレート、データセンターなどの設定）を更新するために使用されます。

4. 仮想マシンを削除する

インターフェースアドレス: /api/vps/v1/virtual-machines/{virtualMachineId}
リクエスト方式: DELETE

パラメータ:

• virtualMachineId: 仮想マシンID（必須）

説明:
このインターフェースは、指定された仮想マシンインスタンスを削除するために使用されます。

5. すべての仮想マシンのリストを取得する

インターフェースアドレス: /api/vps/v1/virtual-machines
リクエスト方式: GET

パラメータ:
なし

説明:
このインターフェースは、ユーザーが所有するすべての仮想マシンのリストを取得するために使用されます。各仮想マシンのID、ホスト名、状態などの情報が返されます。

6. 仮想マシンを起動する

インターフェースアドレス: /api/vps/v1/virtual-machines/{virtualMachineId}/start
リクエスト方式: POST

パラメータ:

• virtualMachineId: 仮想マシンID（必須）

説明:
このインターフェースは、指定された仮想マシンインスタンスを起動するために使用されます。仮想マシンがすでに稼働している場合は何も起こりません。

7. 仮想マシンを停止する

インターフェースアドレス: /api/vps/v1/virtual-machines/{virtualMachineId}/stop
リクエスト方式: POST

パラメータ:

• virtualMachineId: 仮想マシンID（必須）

説明:
このインターフェースは、指定された仮想マシンインスタンスを停止するために使用されます。仮想マシンがすでに停止している場合は何も起こりません。

8. 仮想マシンを再起動する

インターフェースアドレス: /api/vps/v1/virtual-machines/{virtualMachineId}/restart
リクエスト方式: POST

パラメータ:

• virtualMachineId: 仮想マシンID（必須）

説明:
このインターフェースは、指定された仮想マシンインスタンスを再起動するために使用されます。完全に停止してから再起動するのと同じです。

9. 仮想マシンのスナップショットを取得する

インターフェースアドレス: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
リクエスト方式: GET

パラメータ:

• virtualMachineId: 仮想マシンID（必須）

説明:
このインターフェースは、指定された仮想マシンのスナップショット情報を取得するために使用されます。

10. 仮想マシンのスナップショットを作成する

インターフェースアドレス: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
リクエスト方式: POST

パラメータ:

• virtualMachineId: 仮想マシンID（必須）

説明:
このインターフェースは、指定された仮想マシンのスナップショットを作成し、現在の状態とデータをキャプチャします。注意: 新しいスナップショットを作成すると、既存のスナップショットが上書きされます。

11. 仮想マシンのスナップショットを削除する

インターフェースアドレス: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
リクエスト方式: DELETE

パラメータ:

• virtualMachineId: 仮想マシンID（必須）

説明:
このインターフェースは、指定された仮想マシンのスナップショットを削除するために使用されます。

12. 仮想マシンのスナップショットを復元する

インターフェースアドレス: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
リクエスト方式: PUT

パラメータ:

• virtualMachineId: 仮想マシンID（必須）

説明:
このインターフェースは、指定された仮想マシンのスナップショットを復元するために使用されます。