Documentation Powered by Redocly

CharVstack-API (1.0)

Download OpenAPI specification:Download

vm

Create a new VM

VMを作成する

Request Body schema: application/json

VMの作成

name
required
string
memory
required
integer <uint64>
cpu
required
integer

Responses

Request samples

Content type
application/json
{
  • "name": "ubuntu22.04",
  • "memory": 2048,
  • "cpu": 4
}

Response samples

Content type
application/json
{
  • "vm": {
    }
}

Get all VMs list

全てのVM一覧を取得する

Responses

Response samples

Content type
application/json
{
  • "vms": [
    ]
}

Get a VM

個々のVM情報を取得する

path Parameters
vmId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "vm": {
    }
}

Update a VM

VM情報を更新する

path Parameters
vmId
required
string <uuid>
Request Body schema: application/json

VM情報の更新

name
required
string
memory
required
integer <uint64>
cpu
required
integer

Responses

Request samples

Content type
application/json
{
  • "name": "ubuntu20.04",
  • "memory": 4096,
  • "cpu": 12
}

Response samples

Content type
application/json
{
  • "vm": {
    }
}

delete-api-v1-vms-:vmId

VMを削除する

path Parameters
vmId
required
string <uuid>

Responses

Change Power Status

VMの電源状態を操作

path Parameters
vmId
required
string <uuid>
Request Body schema: application/json

VMの電源状態を操作

action
required
string (VmPowerActions)
Enum: "start" "shutdown" "reboot" "reset"

Responses

Request samples

Content type
application/json
{
  • "action": "start"
}

Get Power State

VMの電源状態を取得

path Parameters
vmId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "vm_power": {
    }
}

host

Get a host

ホスト情報を取得する

Responses

Response samples

Content type
application/json
{
  • "host": {
    }
}

type