API docs by Redocly

KCI API (0.49.1)

Download OpenAPI specification:

KCI API documentation

Auth

認証関連の操作

ユーザのログイン

ユーザのメールアドレスとパスワードを使用してログインします。成功すると、認証トークンが返されます。

Request Body schema: application/json
required
email
required
string <email>

ユーザのメールアドレス

password
required
string <password>

ユーザのパスワード

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "refreshToken": "string",
  • "token": "string"
}

ユーザのログアウト

現在の認証トークンを無効化してユーザをログアウトします。

Authorizations:
BearerAuth
Request Body schema: application/json
required
refreshToken
required
string

リフレッシュトークン

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "string"
}

Response samples

Content type
application/json
{}

ユーザのトークンリフレッシュ

リフレッシュトークンを使用して新しい認証トークンを取得します。

Request Body schema: application/json
required
refreshToken
required
string

リフレッシュトークン

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "string"
}

Response samples

Content type
application/json
{
  • "refreshToken": "string",
  • "token": "string"
}

Image

仮想マシンイメージ関連の操作

仮想マシンイメージ一覧の取得

すべての仮想マシンイメージのリストを取得します。

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

仮想マシンイメージの作成

新しい仮想マシンイメージを作成します。

Authorizations:
BearerAuth
Request Body schema: multipart/form-data
required
file
required
string <binary>
required
object (ImageCreateRequest)

仮想マシンイメージ作成リクエストオブジェクト

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "size": 0,
  • "storagePool": {
    }
}

仮想マシンイメージの詳細取得

指定したIDの仮想マシンイメージの詳細情報を取得します。

Authorizations:
BearerAuth
path Parameters
imageId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンイメージの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "size": 0,
  • "storagePool": {
    }
}

仮想マシンイメージの更新

指定したIDの仮想マシンイメージ情報を更新します。descriptionが空の場合、説明は削除されます。

Authorizations:
BearerAuth
path Parameters
imageId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンイメージの一意なID

Request Body schema: application/json
required
name
required
string

仮想マシンイメージの名前

description
string

仮想マシンイメージの説明

Responses

Request samples

Content type
application/json
{
  • "name": "Ubuntu 22.04 LTS",
  • "description": "Ubuntu 22.04 LTS イメージ"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "size": 0,
  • "storagePool": {
    }
}

仮想マシンイメージの部分更新

指定したIDの仮想マシンイメージ情報を部分的に更新します。

Authorizations:
BearerAuth
path Parameters
imageId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンイメージの一意なID

Request Body schema: application/json
required
name
string

仮想マシンイメージの名前

description
string

仮想マシンイメージの説明

Responses

Request samples

Content type
application/json
{
  • "name": "Ubuntu 22.04 LTS",
  • "description": "Ubuntu 22.04 LTS イメージ"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "size": 0,
  • "storagePool": {
    }
}

仮想マシンイメージの削除

指定したIDの仮想マシンイメージを削除します。

Authorizations:
BearerAuth
path Parameters
imageId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンイメージの一意なID

Responses

Response samples

Content type
application/json
{}

ミドルウェア一覧の取得

すべてのミドルウェアのリストを取得します。

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

InstanceType

インスタンスタイプ関連の操作

インスタンスタイプ一覧の取得

すべてのインスタンスタイプのリストを取得します。

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

インスタンスタイプの作成

新しいインスタンスタイプを作成します。

Authorizations:
BearerAuth
Request Body schema: application/json
required
name
required
string

インスタンスタイプの名前

cpuCore
required
integer <int64> [ 1 .. 1099511627776 ]

CPUコア数

memorySize
required
integer <int64> [ 1 .. 1099511627776 ]

メモリサイズ（バイト単位）

Responses

Request samples

Content type
application/json
{
  • "name": "micro",
  • "cpuCore": 4,
  • "memorySize": 8589934592
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "cpuCore": 0,
  • "memorySize": 0
}

インスタンスタイプの詳細取得

指定したIDのインスタンスタイプの詳細情報を取得します。

Authorizations:
BearerAuth
path Parameters
instanceTypeId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

インスタンスタイプの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "cpuCore": 0,
  • "memorySize": 0
}

インスタンスタイプの更新

指定したIDのインスタンスタイプ情報を更新します。

Authorizations:
BearerAuth
path Parameters
instanceTypeId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

インスタンスタイプの一意なID

Request Body schema: application/json
required
name
required
string

インスタンスタイプの名前

cpuCore
required
integer

CPUコア数

memorySize
required
integer

メモリサイズ（バイト単位）

Responses

Request samples

Content type
application/json
{
  • "name": "micro",
  • "cpuCore": 4,
  • "memorySize": 8589934592
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "cpuCore": 0,
  • "memorySize": 0
}

インスタンスタイプの部分更新

指定したIDのインスタンスタイプ情報を部分的に更新します。

Authorizations:
BearerAuth
path Parameters
instanceTypeId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

インスタンスタイプの一意なID

Request Body schema: application/json
required
name
string

インスタンスタイプの名前

cpuCore
integer

CPUコア数

memorySize
integer

メモリサイズ（バイト単位）

Responses

Request samples

Content type
application/json
{
  • "name": "micro",
  • "cpuCore": 4,
  • "memorySize": 8589934592
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "cpuCore": 0,
  • "memorySize": 0
}

インスタンスタイプの削除

指定したIDのインスタンスタイプを削除します。

Authorizations:
BearerAuth
path Parameters
instanceTypeId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

インスタンスタイプの一意なID

Responses

Response samples

Content type
application/json
{}

Node

物理ノード関連の操作

物理ノード一覧の取得

すべての物理ノードのリストを取得します。

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

物理ノードの追加

新しい物理ノードを追加します。

Authorizations:
BearerAuth
Request Body schema: application/json
required
ipAddress
required
string <ipv4>

物理ノードのIPアドレス

rootPassword
required
string

物理ノードのrootパスワード

name
string

物理ノードの名前

isAdmin
boolean

物理ノードが管理ノードかどうかを示すフラグ

Responses

Request samples

Content type
application/json
{
  • "ipAddress": "10.0.0.1",
  • "rootPassword": "ExamplePassword123!",
  • "name": "node-01",
  • "isAdmin": true
}

Response samples

Content type
application/json
{
  • "id": "ff324fb4-18a0-432f-a2fa-d10d57123967",
  • "name": "node-01",
  • "ipAddress": "10.0.0.1",
  • "status": "active",
  • "isAdmin": true,
  • "createdAt": "2024-01-15T10:00:00Z",
  • "cpuUtilization": 0.45,
  • "memoryUtilization": 0.55,
  • "storageUtilization": 0.65
}

物理ノード候補一覧の取得

物理ノードとして追加可能な候補のリストを取得します。

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

物理ノードの詳細取得

指定したIDの物理ノードの詳細情報を取得します。

Authorizations:
BearerAuth
path Parameters
nodeId
required
string <uuid>
Example: a2dcd604-49cb-4e1c-826a-2071d50404a3

物理ノードの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "194d84d4-8811-4ff1-bb68-0e0734990018",
  • "name": "node-01",
  • "ipAddress": "192.168.0.1",
  • "status": "active",
  • "isAdmin": true,
  • "createdAt": "2024-01-15T10:00:00Z",
  • "cpuUtilization": 0.75,
  • "memoryUtilization": 0.6,
  • "storageUtilization": 0.8
}

物理ノードの更新

指定したIDの物理ノード情報を更新します。

Authorizations:
BearerAuth
path Parameters
nodeId
required
string <uuid>
Example: bba6cb32-c841-4ace-9bc8-c3c5288b2e5f

物理ノードの一意なID

Request Body schema: application/json
required
name
required
string

物理ノードの名前

isAdmin
required
boolean

物理ノードが管理ノードかどうかを示すフラグ

Responses

Request samples

Content type
application/json
{
  • "name": "node-01",
  • "isAdmin": true
}

Response samples

Content type
application/json
{
  • "id": "194d84d4-8811-4ff1-bb68-0e0734990018",
  • "name": "node-01",
  • "ipAddress": "192.168.0.1",
  • "status": "active",
  • "isAdmin": true,
  • "createdAt": "2024-01-15T10:00:00Z",
  • "cpuUtilization": 0.75,
  • "memoryUtilization": 0.6,
  • "storageUtilization": 0.8
}

物理ノードの部分更新

指定したIDの物理ノード情報を更新します。

Authorizations:
BearerAuth
path Parameters
nodeId
required
string <uuid>
Example: bba6cb32-c841-4ace-9bc8-c3c5288b2e5f

物理ノードの一意なID

Request Body schema: application/json
required
name
string

物理ノードの名前

isAdmin
boolean

物理ノードが管理ノードかどうかを示すフラグ

Responses

Request samples

Content type
application/json
{
  • "name": "node-01",
  • "isAdmin": true
}

Response samples

Content type
application/json
{
  • "id": "194d84d4-8811-4ff1-bb68-0e0734990018",
  • "name": "node-01",
  • "ipAddress": "192.168.0.1",
  • "status": "active",
  • "isAdmin": true,
  • "createdAt": "2024-01-15T10:00:00Z",
  • "cpuUtilization": 0.75,
  • "memoryUtilization": 0.6,
  • "storageUtilization": 0.8
}

物理ノードの削除

指定したIDの物理ノードを削除します。

Authorizations:
BearerAuth
path Parameters
nodeId
required
string <uuid>
Example: bba6cb32-c841-4ace-9bc8-c3c5288b2e5f

物理ノードの一意なID

Responses

Response samples

Content type
application/json
{}

ノードに新規接続されたストレージデバイスの一覧取得

指定したIDの物理ノードに新規接続されたストレージデバイスの一覧を取得します。

Authorizations:
BearerAuth
path Parameters
nodeId
required
string <uuid>
Example: 86c4bfd5-b791-4733-852c-15c8bde42574

物理ノードの一意なID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SecurityGroup

セキュリティグループ関連の操作

セキュリティグループ一覧の取得

すべてのセキュリティグループのリストを取得します。

Authorizations:
BearerAuth
query Parameters
scope
string
Enum: "mine" "all"

表示範囲(mine=自分のもの, all=全て(管理者のみ)、指定のない場合はmine)。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

セキュリティグループの作成

新しいセキュリティグループを作成します。

Authorizations:
BearerAuth
Request Body schema: application/json
required
name
required
string

セキュリティグループの名前

description
string

セキュリティグループの説明

required
Array of objects (SecurityRuleCreateRequest)

Responses

Request samples

Content type
application/json
{
  • "name": "web-servers",
  • "description": "Security group for web servers",
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "owner": {
    },
  • "rules": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z"
}

セキュリティグループの詳細取得

指定したIDのセキュリティグループの詳細情報を取得します。

Authorizations:
BearerAuth
path Parameters
groupId
required
string <uuid>

セキュリティグループの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "owner": {
    },
  • "rules": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z"
}

セキュリティグループの更新

指定したIDのセキュリティグループ情報を更新します。

Authorizations:
BearerAuth
path Parameters
groupId
required
string <uuid>

セキュリティグループの一意なID

Request Body schema: application/json
required
name
required
string

セキュリティグループの名前

description
required
string

セキュリティグループの説明

Responses

Request samples

Content type
application/json
{
  • "name": "web-servers",
  • "description": "Security group for web servers"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "owner": {
    },
  • "rules": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z"
}

セキュリティグループの部分更新

指定したIDのセキュリティグループ情報を更新します。

Authorizations:
BearerAuth
path Parameters
groupId
required
string <uuid>

セキュリティグループの一意なID

Request Body schema: application/json
required
name
string

セキュリティグループの名前

description
string

セキュリティグループの説明

Responses

Request samples

Content type
application/json
{
  • "name": "web-servers",
  • "description": "Security group for web servers"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "owner": {
    },
  • "rules": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z"
}

セキュリティグループの削除

指定したIDのセキュリティグループを削除します。

Authorizations:
BearerAuth
path Parameters
groupId
required
string <uuid>

セキュリティグループの一意なID

Responses

Response samples

Content type
application/json
{}

セキュリティグループルールの一覧取得

指定したセキュリティグループに関連付けられたすべてのルールを取得します。

Authorizations:
BearerAuth
path Parameters
groupId
required
string <uuid>
Example: bba6cb32-c841-4ace-9bc8-c3c5288b2e5f

セキュリティグループの一意なID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

セキュリティグループルールの追加

指定したセキュリティグループに新しいルールを追加します。

Authorizations:
BearerAuth
path Parameters
groupId
required
string <uuid>
Example: bba6cb32-c841-4ace-9bc8-c3c5288b2e5f

セキュリティグループの一意なID

Request Body schema: application/json
required
name
required
string

セキュリティルールの名前

ruleType
required
string
Enum: "inbound" "outbound"

ルールのタイプ（インバウンドまたはアウトバウンド）

port
required
integer or null

適用されるポート番号。NULLの場合は全ポート対象

protocol
required
string
Enum: "tcp" "udp" "icmp" "any"

適用されるプロトコル

targetIp
required
string^(\d{1,3}\.){3}\d{1,3}/([0-9]|[12][0-9]|3[0-2...

ターゲットIPアドレス(CIDR表記)

action
required
string
Enum: "allow" "deny"

ルールのアクション（許可または拒否）

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "ruleType": "inbound",
  • "port": 22,
  • "protocol": "tcp",
  • "targetIp": "192.0.2.0/24",
  • "action": "allow"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "ruleType": "inbound",
  • "port": 22,
  • "protocol": "tcp",
  • "targetIp": "192.0.2.0/24",
  • "action": "allow",
  • "createdAt": "2019-08-24T14:15:22Z"
}

セキュリティルールの一括追加、更新、削除

指定したセキュリティグループ内で複数のルールを一括で追加、更新、または削除します。

Authorizations:
BearerAuth
path Parameters
groupId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

セキュリティグループの一意なID

Request Body schema: application/json
required
Array of objects (SecurityRuleCreateRequest)

追加するセキュリティルールのリスト

Array of objects

更新するセキュリティルールのリスト

remove
Array of strings <uuid> [ items <uuid > ]

削除するセキュリティルールのIDリスト

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "patch": [
    ],
  • "remove": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

セキュリティグループルールの詳細取得

指定したセキュリティグループ内の特定のルールの詳細情報を取得します。

Authorizations:
BearerAuth
path Parameters
groupId
required
string <uuid>
Example: bba6cb32-c841-4ace-9bc8-c3c5288b2e5f

セキュリティグループの一意なID

ruleId
required
string <uuid>
Example: bba6cb32-c841-4ace-9bc8-c3c5288b2e5f

セキュリティグループルールの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "ruleType": "inbound",
  • "port": 22,
  • "protocol": "tcp",
  • "targetIp": "192.0.2.0/24",
  • "action": "allow",
  • "createdAt": "2019-08-24T14:15:22Z"
}

セキュリティグループルールの更新

指定したセキュリティグループ内の特定のルールを更新します。

Authorizations:
BearerAuth
path Parameters
groupId
required
string <uuid>
Example: bba6cb32-c841-4ace-9bc8-c3c5288b2e5f

セキュリティグループの一意なID

ruleId
required
string <uuid>
Example: bba6cb32-c841-4ace-9bc8-c3c5288b2e5f

セキュリティグループルールの一意なID

Request Body schema: application/json
required
name
required
string

セキュリティルールの名前

ruleType
required
string
Enum: "inbound" "outbound"

ルールのタイプ（インバウンドまたはアウトバウンド）

port
required
integer or null

適用されるポート番号。NULLの場合は全ポート対象

protocol
required
string
Enum: "tcp" "udp" "icmp" "any"

適用されるプロトコル

targetIp
required
string^(\d{1,3}\.){3}\d{1,3}/([0-9]|[12][0-9]|3[0-2...

ターゲットIPアドレス(CIDR表記)

action
required
string
Enum: "allow" "deny"

ルールのアクション（許可または拒否）

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "ruleType": "inbound",
  • "port": 22,
  • "protocol": "tcp",
  • "targetIp": "192.0.2.0/24",
  • "action": "allow"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "ruleType": "inbound",
  • "port": 22,
  • "protocol": "tcp",
  • "targetIp": "192.0.2.0/24",
  • "action": "allow",
  • "createdAt": "2019-08-24T14:15:22Z"
}

セキュリティグループルールの部分更新

指定したセキュリティグループ内の特定のルールを部分的に更新します。

Authorizations:
BearerAuth
path Parameters
groupId
required
string <uuid>
Example: bba6cb32-c841-4ace-9bc8-c3c5288b2e5f

セキュリティグループの一意なID

ruleId
required
string <uuid>
Example: bba6cb32-c841-4ace-9bc8-c3c5288b2e5f

セキュリティグループルールの一意なID

Request Body schema: application/json
required
name
string

セキュリティルールの名前

ruleType
string
Enum: "inbound" "outbound"

ルールのタイプ（インバウンドまたはアウトバウンド）

port
integer or null

適用されるポート番号。NULLの場合は全ポート対象

protocol
string
Enum: "tcp" "udp" "icmp" "any"

適用されるプロトコル

targetIp
string^(\d{1,3}\.){3}\d{1,3}/([0-9]|[12][0-9]|3[0-2...

ターゲットIPアドレス(CIDR表記)

action
string
Enum: "allow" "deny"

ルールのアクション（許可または拒否）

id
string <uuid>

セキュリティルールを識別するための一意なID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "ruleType": "inbound",
  • "port": 22,
  • "protocol": "tcp",
  • "targetIp": "192.0.2.0/24",
  • "action": "allow",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "ruleType": "inbound",
  • "port": 22,
  • "protocol": "tcp",
  • "targetIp": "192.0.2.0/24",
  • "action": "allow",
  • "createdAt": "2019-08-24T14:15:22Z"
}

セキュリティグループルールの削除

指定したセキュリティグループ内の特定のルールを削除します。

Authorizations:
BearerAuth
path Parameters
groupId
required
string <uuid>
Example: bba6cb32-c841-4ace-9bc8-c3c5288b2e5f

セキュリティグループの一意なID

ruleId
required
string <uuid>
Example: bba6cb32-c841-4ace-9bc8-c3c5288b2e5f

セキュリティグループルールの一意なID

Responses

Response samples

Content type
application/json
{}

StoragePool

ストレージプール関連の操作

ストレージプール一覧の取得

すべてのストレージプールのリストを取得します。

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ストレージプールの作成

新しいストレージプールを作成します。

Authorizations:
BearerAuth
Request Body schema: application/json
required
nodeId
required
string <uuid>

ストレージプールが属する物理ノードのID

devicePath
required
string

ストレージプールが使用するデバイスのパス

name
required
string

ストレージプールの名前

hasNetworkAccess
required
boolean

ストレージプールがネットワークアクセス可能かどうかを示すフラグ

Responses

Request samples

Content type
application/json
{
  • "nodeId": "550e8400-e29b-41d4-a716-446655440000",
  • "devicePath": "/dev/sdb",
  • "name": "Node1 Pool 1",
  • "hasNetworkAccess": true
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "name": "Node1 Pool 1",
  • "node": {
    },
  • "createdAt": "2024-01-01T12:00:00Z",
  • "totalSize": 1099511627776,
  • "usedSize": 549755813888,
  • "availableSize": 549755813888,
  • "hasNetworkAccess": true
}

指定した物理ノードから利用可能なストレージプール一覧の取得

指定した物理ノードから利用可能なストレージプールのリストを取得します。

Authorizations:
BearerAuth
path Parameters
nodeId
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

物理ノードの一意なID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ストレージプールの詳細取得

指定したIDのストレージプールの詳細情報を取得します。

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ストレージプールの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "name": "Node1 Pool 1",
  • "node": {
    },
  • "createdAt": "2024-01-01T12:00:00Z",
  • "totalSize": 1099511627776,
  • "usedSize": 549755813888,
  • "availableSize": 549755813888,
  • "hasNetworkAccess": true
}

ストレージプールの更新

指定したIDのストレージプールの情報を更新します。

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ストレージプールの一意なID

Request Body schema: application/json
required
name
required
string

ストレージプールの名前

hasNetworkAccess
required
boolean

ストレージプールがネットワークアクセス可能かどうかを示すフラグ

Responses

Request samples

Content type
application/json
{
  • "name": "Node1 Pool 1",
  • "hasNetworkAccess": true
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "name": "Node1 Pool 1",
  • "node": {
    },
  • "createdAt": "2024-01-01T12:00:00Z",
  • "totalSize": 1099511627776,
  • "usedSize": 549755813888,
  • "availableSize": 549755813888,
  • "hasNetworkAccess": true
}

ストレージプールの部分更新

指定したIDのストレージプールの情報を部分的に更新します。

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ストレージプールの一意なID

Request Body schema: application/json
required
name
string

ストレージプールの名前

hasNetworkAccess
boolean

ストレージプールがネットワークアクセス可能かどうかを示すフラグ

Responses

Request samples

Content type
application/json
{
  • "name": "Node1 Pool 1",
  • "hasNetworkAccess": true
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "name": "Node1 Pool 1",
  • "node": {
    },
  • "createdAt": "2024-01-01T12:00:00Z",
  • "totalSize": 1099511627776,
  • "usedSize": 549755813888,
  • "availableSize": 549755813888,
  • "hasNetworkAccess": true
}

ストレージプールの削除

指定したIDのストレージプールを削除します。

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ストレージプールの一意なID

Responses

Response samples

Content type
application/json
{}

User

ユーザ関連の操作

ユーザ一覧の取得

すべてのユーザのリストを取得します。

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ユーザの作成

新しいユーザを作成します。

Authorizations:
BearerAuth
Request Body schema: application/json
required
password
required
string <password>

ユーザのパスワード

name
required
string

ユーザの表示名

email
required
string <email>

ユーザのメールアドレス

maxCpuCore
required
integer or null

ユーザが使用できる最大CPUコア数 制限がある場合だけ設定されます

maxMemorySize
required
integer or null

ユーザが使用できる最大メモリサイズ（バイト単位） 制限がある場合だけ設定されます

maxStorageSize
required
integer or null

ユーザが使用できる最大ストレージサイズ（バイト単位） 制限がある場合だけ設定されます

isAdmin
required
boolean

ユーザが管理者権限を持つかどうか

isImageAdmin
boolean

ユーザがイメージ管理者かどうかを示すフラグ

isInstanceTypeAdmin
boolean

ユーザがインスタンスタイプ管理者かどうかを示すフラグ

isVirtualMachineAdmin
boolean

ユーザが仮想マシン管理者かどうかを示すフラグ

isNetworkAdmin
boolean

ユーザがネットワーク管理者かどうかを示すフラグ

isSecurityGroupAdmin
boolean

ユーザがセキュリティグループ管理者かどうかを示すフラグ

isNodeAdmin
boolean

ユーザが物理ノード管理者かどうかを示すフラグ

Responses

Request samples

Content type
application/json
{
  • "password": "StrongP@ssw0rd!",
  • "name": "string",
  • "email": "user@example.com",
  • "maxCpuCore": 32,
  • "maxMemorySize": 17179869184,
  • "maxStorageSize": 1099511627776,
  • "isAdmin": true,
  • "isImageAdmin": false,
  • "isInstanceTypeAdmin": false,
  • "isVirtualMachineAdmin": false,
  • "isNetworkAdmin": false,
  • "isSecurityGroupAdmin": false,
  • "isNodeAdmin": false
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "user@example.com",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isAdmin": true,
  • "lastLoginAt": "2019-08-24T14:15:22Z",
  • "maxCpuCore": 32,
  • "maxMemorySize": 17179869184,
  • "maxStorageSize": 1099511627776,
  • "totpInfo": {
    },
  • "isImageAdmin": false,
  • "isInstanceTypeAdmin": false,
  • "isNodeAdmin": false,
  • "isVirtualMachineAdmin": false,
  • "isNetworkAdmin": false,
  • "isSecurityGroupAdmin": false
}

自分のユーザ情報取得

認証されたユーザの詳細情報を取得します。

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "user@example.com",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isAdmin": true,
  • "lastLoginAt": "2019-08-24T14:15:22Z",
  • "maxCpuCore": 32,
  • "maxMemorySize": 17179869184,
  • "maxStorageSize": 1099511627776,
  • "totpInfo": {
    },
  • "isImageAdmin": false,
  • "isInstanceTypeAdmin": false,
  • "isNodeAdmin": false,
  • "isVirtualMachineAdmin": false,
  • "isNetworkAdmin": false,
  • "isSecurityGroupAdmin": false
}

ユーザの詳細取得

指定したIDのユーザの詳細情報を取得します。

Authorizations:
BearerAuth
path Parameters
userId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ユーザの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "user@example.com",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isAdmin": true,
  • "lastLoginAt": "2019-08-24T14:15:22Z",
  • "maxCpuCore": 32,
  • "maxMemorySize": 17179869184,
  • "maxStorageSize": 1099511627776,
  • "totpInfo": {
    },
  • "isImageAdmin": false,
  • "isInstanceTypeAdmin": false,
  • "isNodeAdmin": false,
  • "isVirtualMachineAdmin": false,
  • "isNetworkAdmin": false,
  • "isSecurityGroupAdmin": false
}

ユーザの更新

指定したIDのユーザ情報を更新します。

Authorizations:
BearerAuth
path Parameters
userId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ユーザの一意なID

Request Body schema: application/json
required
name
required
string

ユーザの表示名

email
required
string <email>

ユーザのメールアドレス

maxCpuCore
required
integer or null

ユーザが使用できる最大CPUコア数 制限がある場合だけ設定されます

maxMemorySize
required
integer or null

ユーザが使用できる最大メモリサイズ（バイト単位） 制限がある場合だけ設定されます

maxStorageSize
required
integer or null

ユーザが使用できる最大ストレージサイズ（バイト単位） 制限がある場合だけ設定されます

isAdmin
required
boolean

ユーザが管理者権限を持つかどうか

isImageAdmin
required
boolean

ユーザがイメージ管理者かどうかを示すフラグ

isInstanceTypeAdmin
required
boolean

ユーザがインスタンスタイプ管理者かどうかを示すフラグ

isVirtualMachineAdmin
required
boolean

ユーザが仮想マシン管理者かどうかを示すフラグ

isNetworkAdmin
required
boolean

ユーザがネットワーク管理者かどうかを示すフラグ

isSecurityGroupAdmin
required
boolean

ユーザがセキュリティグループ管理者かどうかを示すフラグ

isNodeAdmin
required
boolean

ユーザが物理ノード管理者かどうかを示すフラグ

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "maxCpuCore": 32,
  • "maxMemorySize": 17179869184,
  • "maxStorageSize": 1099511627776,
  • "isAdmin": true,
  • "isImageAdmin": false,
  • "isInstanceTypeAdmin": false,
  • "isVirtualMachineAdmin": false,
  • "isNetworkAdmin": false,
  • "isSecurityGroupAdmin": false,
  • "isNodeAdmin": false
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "user@example.com",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isAdmin": true,
  • "lastLoginAt": "2019-08-24T14:15:22Z",
  • "maxCpuCore": 32,
  • "maxMemorySize": 17179869184,
  • "maxStorageSize": 1099511627776,
  • "totpInfo": {
    },
  • "isImageAdmin": false,
  • "isInstanceTypeAdmin": false,
  • "isNodeAdmin": false,
  • "isVirtualMachineAdmin": false,
  • "isNetworkAdmin": false,
  • "isSecurityGroupAdmin": false
}

ユーザの部分更新

指定したIDのユーザ情報を部分的に更新します。

Authorizations:
BearerAuth
path Parameters
userId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ユーザの一意なID

Request Body schema: application/json
required
name
string

ユーザの表示名

email
string <email>

ユーザのメールアドレス

maxCpuCore
integer or null

ユーザが使用できる最大CPUコア数 制限がある場合だけ設定されます

maxMemorySize
integer or null

ユーザが使用できる最大メモリサイズ（バイト単位） 制限がある場合だけ設定されます

maxStorageSize
integer or null

ユーザが使用できる最大ストレージサイズ（バイト単位） 制限がある場合だけ設定されます

isAdmin
boolean

ユーザが管理者権限を持つかどうか

isImageAdmin
boolean

ユーザがイメージ管理者かどうかを示すフラグ

isInstanceTypeAdmin
boolean

ユーザがインスタンスタイプ管理者かどうかを示すフラグ

isVirtualMachineAdmin
boolean

ユーザが仮想マシン管理者かどうかを示すフラグ

isNetworkAdmin
boolean

ユーザがネットワーク管理者かどうかを示すフラグ

isSecurityGroupAdmin
boolean

ユーザがセキュリティグループ管理者かどうかを示すフラグ

isNodeAdmin
boolean

ユーザが物理ノード管理者かどうかを示すフラグ

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "maxCpuCore": 32,
  • "maxMemorySize": 17179869184,
  • "maxStorageSize": 1099511627776,
  • "isAdmin": true,
  • "isImageAdmin": false,
  • "isInstanceTypeAdmin": false,
  • "isVirtualMachineAdmin": false,
  • "isNetworkAdmin": false,
  • "isSecurityGroupAdmin": false,
  • "isNodeAdmin": false
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "user@example.com",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isAdmin": true,
  • "lastLoginAt": "2019-08-24T14:15:22Z",
  • "maxCpuCore": 32,
  • "maxMemorySize": 17179869184,
  • "maxStorageSize": 1099511627776,
  • "totpInfo": {
    },
  • "isImageAdmin": false,
  • "isInstanceTypeAdmin": false,
  • "isNodeAdmin": false,
  • "isVirtualMachineAdmin": false,
  • "isNetworkAdmin": false,
  • "isSecurityGroupAdmin": false
}

ユーザの削除

指定したIDのユーザを削除します。

Authorizations:
BearerAuth
path Parameters
userId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ユーザの一意なID

Responses

Response samples

Content type
application/json
{}

ユーザのパスワードを変更する

指定したIDのユーザのパスワードを変更します。

Authorizations:
BearerAuth
path Parameters
userId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ユーザの一意なID

Request Body schema: application/json
required
currentPassword
required
string

現在のパスワード

newPassword
required
string

新しいパスワード

Responses

Request samples

Content type
application/json
{
  • "currentPassword": "string",
  • "newPassword": "string"
}

Response samples

Content type
application/json
{}

VirtualMachine

仮想マシン関連の操作

仮想マシン一覧の取得

すべての仮想マシンのリストを取得します。

Authorizations:
BearerAuth
query Parameters
scope
string
Enum: "mine" "all"

表示範囲(mine=自分のもの, all=全て(管理者のみ)、指定のない場合はmine)。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

仮想マシンの作成

新しい仮想マシンを作成します。インスタンスタイプとカスタムスペックの両方が指定された場合、カスタムスペックが優先されます。

Authorizations:
BearerAuth
Request Body schema: application/json
required
publicKey
required
string

仮想マシンに設定するSSH公開鍵

nodeId
required
string <uuid>

仮想マシンを配置するノードのID

imageId
required
string <uuid>

仮想マシンにインストールするOSイメージのID

middlewareId
string or null <uuid>

インストールするミドルウェアのID

subnetIds
required
Array of strings <uuid> [ items <uuid > ]

仮想マシンを配置するサブネットのIDのリスト

required
Array of objects

仮想マシンにアタッチするストレージのリスト

securityGroupIds
required
Array of strings <uuid> [ items <uuid > ]

関連付けるセキュリティグループのIDリスト

name
required
string

仮想マシンの名前

required
VirtualMachineWithInstanceTypeUpdatable (object) or VirtualMachineWithCustomSpecUpdatable (object)

仮想マシンのスペック情報

Responses

Request samples

Content type
application/json
{
  • "publicKey": "string",
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177",
  • "imageId": "bbefe473-c66a-4040-85cf-1c7e6f0b3830",
  • "middlewareId": "08656f4b-6023-4125-b23c-1184f0fafc96",
  • "subnetIds": [
    ],
  • "storages": [
    ],
  • "securityGroupIds": [
    ],
  • "name": "string",
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "running",
  • "node": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "securityGroups": [
    ],
  • "storages": [
    ],
  • "networkInterfaces": [
    ],
  • "cpuUtilization": 0.55,
  • "memoryUtilization": 0.7,
  • "storageUtilization": 0.4,
  • "cpuCore": 0,
  • "memorySize": 0
}

仮想マシンの詳細取得

指定したIDの仮想マシンの詳細情報を取得します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "running",
  • "node": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "securityGroups": [
    ],
  • "storages": [
    ],
  • "networkInterfaces": [
    ],
  • "cpuUtilization": 0.55,
  • "memoryUtilization": 0.7,
  • "storageUtilization": 0.4,
  • "cpuCore": 0,
  • "memorySize": 0
}

仮想マシンの更新

指定したIDの仮想マシン情報を更新します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Request Body schema: application/json
required
name
required
string

仮想マシンの名前

VirtualMachineWithInstanceTypeUpdatable (object) or VirtualMachineWithCustomSpecUpdatable (object)

仮想マシンのスペック情報

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "running",
  • "node": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "securityGroups": [
    ],
  • "storages": [
    ],
  • "networkInterfaces": [
    ],
  • "cpuUtilization": 0.55,
  • "memoryUtilization": 0.7,
  • "storageUtilization": 0.4,
  • "cpuCore": 0,
  • "memorySize": 0
}

仮想マシンの部分更新

指定したIDの仮想マシン情報を部分的に更新します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Request Body schema: application/json
required
name
string

仮想マシンの名前

VirtualMachineWithInstanceTypeUpdatable (object) or VirtualMachineWithCustomSpecUpdatable (object)

仮想マシンのスペック情報

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "running",
  • "node": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "securityGroups": [
    ],
  • "storages": [
    ],
  • "networkInterfaces": [
    ],
  • "cpuUtilization": 0.55,
  • "memoryUtilization": 0.7,
  • "storageUtilization": 0.4,
  • "cpuCore": 0,
  • "memorySize": 0
}

仮想マシンの削除

指定したIDの仮想マシンを削除します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Responses

Response samples

Content type
application/json
{}

仮想マシンのネットワークインターフェース一覧取得

指定したIDの仮想マシンに関連付けられたネットワークインターフェースの一覧を取得します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

仮想マシンへのネットワークインターフェースの追加

指定したIDの仮想マシンにネットワークインターフェースを追加します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Request Body schema: application/json
required
name
required
string

ネットワークインターフェースの名前

subnetId
required
string <uuid>

ネットワークインターフェースが属するサブネットのID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "subnetId": "1f232bf0-7b90-456e-b9b0-38d9fea4171a"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "macAddress": "02:42:ac:11:00:02",
  • "ipAddress": "10.0.0.0/32",
  • "subnet": {
    }
}

仮想マシンへのネットワークインターフェースの一括編集

指定したIDの仮想マシンにネットワークインターフェースを一括で編集します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Request Body schema: application/json
required
Any of
required
Array of objects (NetworkInterfaceCreateRequest)

追加するネットワークインターフェースのリスト

Array of objects

更新するネットワークインターフェースのリスト

remove
Array of strings <uuid> [ items <uuid > ]

削除するネットワークインターフェースのIDリスト

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "patch": [
    ],
  • "remove": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

仮想マシンのネットワークインターフェース詳細取得

指定したIDの仮想マシンに関連付けられたネットワークインターフェースの詳細を取得します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

nicId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ネットワークインターフェースの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "macAddress": "02:42:ac:11:00:02",
  • "ipAddress": "10.0.0.0/32",
  • "subnet": {
    }
}

仮想マシンのネットワークインターフェース編集

指定したIDの仮想マシンに関連付けられたネットワークインターフェースを編集します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

nicId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ネットワークインターフェースの一意なID

Request Body schema: application/json
required
name
required
string

ネットワークインターフェースの名前

subnetId
required
string <uuid>

ネットワークインターフェースが属するサブネットのID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "subnetId": "1f232bf0-7b90-456e-b9b0-38d9fea4171a"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "macAddress": "02:42:ac:11:00:02",
  • "ipAddress": "10.0.0.0/32",
  • "subnet": {
    }
}

仮想マシンのネットワークインターフェース部分編集

指定したIDの仮想マシンに関連付けられたネットワークインターフェースを部分編集します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

nicId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ネットワークインターフェースの一意なID

Request Body schema: application/json
required
name
string

ネットワークインターフェースの名前

subnetId
string <uuid>

ネットワークインターフェースが属するサブネットのID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "subnetId": "1f232bf0-7b90-456e-b9b0-38d9fea4171a"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "macAddress": "02:42:ac:11:00:02",
  • "ipAddress": "10.0.0.0/32",
  • "subnet": {
    }
}

仮想マシンのネットワークインターフェース削除

指定したIDの仮想マシンに関連付けられたネットワークインターフェースを削除します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

nicId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ネットワークインターフェースの一意なID

Responses

Response samples

Content type
application/json
{}

仮想マシンの再起動

指定したIDの仮想マシンを再起動します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "running",
  • "node": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "securityGroups": [
    ],
  • "storages": [
    ],
  • "networkInterfaces": [
    ],
  • "cpuUtilization": 0.55,
  • "memoryUtilization": 0.7,
  • "storageUtilization": 0.4,
  • "cpuCore": 0,
  • "memorySize": 0
}

仮想マシンの強制リセット

指定したIDの仮想マシンを強制的にリセットします。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "running",
  • "node": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "securityGroups": [
    ],
  • "storages": [
    ],
  • "networkInterfaces": [
    ],
  • "cpuUtilization": 0.55,
  • "memoryUtilization": 0.7,
  • "storageUtilization": 0.4,
  • "cpuCore": 0,
  • "memorySize": 0
}

仮想マシンのセキュリティグループ一覧取得

指定したIDの仮想マシンに関連付けられたセキュリティグループの一覧を取得します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

仮想マシンへのセキュリティグループの追加

指定したIDの仮想マシンにセキュリティグループを追加します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Request Body schema: application/json
required
securityGroupId
required
string <uuid>

追加するセキュリティグループの一意なID

Responses

Request samples

Content type
application/json
{
  • "securityGroupId": "77479d4d-34cb-49d6-ba13-f9aef28de5c2"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "owner": {
    },
  • "rules": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z"
}

仮想マシンセキュリティグループの一括編集

指定したIDの仮想マシンにセキュリティグループを一括で編集します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Request Body schema: application/json
required
Array of objects

追加するセキュリティグループのリスト

remove
Array of strings <uuid> [ items <uuid > ]

削除するセキュリティグループのIDリスト

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "remove": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

仮想マシンのセキュリティグループ関連付け削除

指定したIDの仮想マシンに関連付けられたセキュリティグループの関連付けを削除します。セキュリティグループの削除ではありません。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

sgId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

セキュリティグループの一意なID

Responses

Response samples

Content type
application/json
{}

仮想マシンのシャットダウン

指定したIDの仮想マシンをシャットダウンします。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "running",
  • "node": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "securityGroups": [
    ],
  • "storages": [
    ],
  • "networkInterfaces": [
    ],
  • "cpuUtilization": 0.55,
  • "memoryUtilization": 0.7,
  • "storageUtilization": 0.4,
  • "cpuCore": 0,
  • "memorySize": 0
}

仮想マシンの起動

指定したIDの仮想マシンを起動します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "running",
  • "node": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "securityGroups": [
    ],
  • "storages": [
    ],
  • "networkInterfaces": [
    ],
  • "cpuUtilization": 0.55,
  • "memoryUtilization": 0.7,
  • "storageUtilization": 0.4,
  • "cpuCore": 0,
  • "memorySize": 0
}

仮想マシンの強制停止

指定したIDの仮想マシンを強制的に停止します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "running",
  • "node": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "securityGroups": [
    ],
  • "storages": [
    ],
  • "networkInterfaces": [
    ],
  • "cpuUtilization": 0.55,
  • "memoryUtilization": 0.7,
  • "storageUtilization": 0.4,
  • "cpuCore": 0,
  • "memorySize": 0
}

仮想マシンのストレージ一覧取得

指定したIDの仮想マシンに関連付けられたストレージの一覧を取得します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

仮想マシンへのストレージの追加

指定したIDの仮想マシンにストレージを追加します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Request Body schema: application/json
required
name
required
string

ストレージの名前

size
required
integer

アタッチするストレージのサイズ（バイト単位）

poolId
required
string <uuid>

ストレージプールのID

backupId
string <uuid>

ストレージのバックアップ元ID(オプション)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "size": 0,
  • "poolId": "d038cb61-929c-440e-b3d3-abb22c5538f5",
  • "backupId": "eb7cea43-10b2-42dd-8819-ab9aed37565f"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "size": 0,
  • "pool": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "devicePath": "/dev/vdb"
}

仮想マシンのストレージ一括編集

指定したIDの仮想マシンにストレージを一括で編集します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

Request Body schema: application/json
required
Array of objects (StorageCreateRequest)

追加する仮想ストレージのリスト

Array of objects

更新する仮想ストレージのリスト

remove
Array of strings <uuid> [ items <uuid > ]

削除する仮想ストレージのIDリスト

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "patch": [
    ],
  • "remove": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

仮想マシンのストレージ詳細取得

指定したIDの仮想マシンに関連付けられたストレージの詳細を取得します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

storageId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ストレージの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "size": 0,
  • "pool": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "devicePath": "/dev/vdb"
}

仮想マシンのストレージ編集

指定したIDの仮想マシンに関連付けられたストレージを編集します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

storageId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ストレージの一意なID

Request Body schema: application/json
required
name
required
string

ストレージの名前

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "size": 0,
  • "pool": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "devicePath": "/dev/vdb"
}

仮想マシンのストレージ部分編集

指定したIDの仮想マシンに関連付けられたストレージを部分編集します。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

storageId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ストレージの一意なID

Request Body schema: application/json
required
name
string

ストレージの名前

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "size": 0,
  • "pool": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "devicePath": "/dev/vdb"
}

仮想マシンのストレージ割り当て解除

指定したIDの仮想マシンに関連付けられたストレージを割り当て解除します。実際のストレージ自体は削除されません。

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想マシンの一意なID

storageId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

ストレージの一意なID

Responses

Response samples

Content type
application/json
{}

VirtualNetwork

仮想ネットワーク関連の操作

仮想ネットワーク一覧の取得

すべての仮想ネットワークのリストを取得します。

Authorizations:
BearerAuth
query Parameters
scope
string
Enum: "mine" "all"

表示範囲(mine=自分のもの, all=全て(管理者のみ)、指定のない場合はmine。)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

仮想ネットワークの作成

新しい仮想ネットワークを作成します。

Authorizations:
BearerAuth
Request Body schema: application/json
required
name
required
string

仮想ネットワークの名前

cidr
required
string^(\d{1,3}\.){3}\d{1,3}/([0-9]|[12][0-9]|3[0-2...

CIDR形式のネットワークアドレス

required
Array of objects (SubnetCreateRequest) non-empty

仮想ネットワーク作成時に同時に作成するサブネットのリスト

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "cidr": "10.0.0.0/16",
  • "initialSubnets": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "cidr": "10.0.0.0/16",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "subnets": [
    ]
}

仮想ネットワークの詳細取得

指定したIDの仮想ネットワークの詳細情報を取得します。

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想ネットワークの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "cidr": "10.0.0.0/16",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "subnets": [
    ]
}

仮想ネットワークの更新

指定したIDの仮想ネットワーク情報を更新します。

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想ネットワークの一意なID

Request Body schema: application/json
required
name
string

仮想ネットワークの名前

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "cidr": "10.0.0.0/16",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "subnets": [
    ]
}

仮想ネットワークの更新

指定したIDの仮想ネットワーク情報を完全に更新します。

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想ネットワークの一意なID

Request Body schema: application/json
required
name
required
string

仮想ネットワークの名前

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "cidr": "10.0.0.0/16",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "subnets": [
    ]
}

仮想ネットワークの削除

指定したIDの仮想ネットワークを削除します。

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想ネットワークの一意なID

Responses

Response samples

Content type
application/json
{}

サブネットの追加

指定した仮想ネットワークに新しいサブネットを追加します。

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想ネットワークの一意なID

Request Body schema: application/json
required
name
required
string

サブネットの名前

cidr
required
string^(\d{1,3}\.){3}\d{1,3}/([0-9]|[12][0-9]|3[0-2...

CIDR形式のサブネットアドレス

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "cidr": "192.168.1.0/24"
}

Response samples

Content type
application/json
{
  • "parent": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "cidr": "10.0.0.0/24",
  • "createdAt": "2019-08-24T14:15:22Z"
}

サブネットの一括更新

指定した仮想ネットワーク内のサブネットを一括で更新します。

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想ネットワークの一意なID

Request Body schema: application/json
required
Array of objects (SubnetCreateRequest)

作成するサブネットのリスト

Array of objects

更新するサブネットのリスト

remove
Array of strings <uuid> [ items <uuid > ]

削除するサブネットのIDリスト

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "patch": [
    ],
  • "remove": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

サブネットの詳細取得

指定した仮想ネットワーク内のサブネットの詳細情報を取得します。

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想ネットワークの一意なID

subnetId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

サブネットの一意なID

Responses

Response samples

Content type
application/json
{
  • "parent": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "cidr": "10.0.0.0/24",
  • "createdAt": "2019-08-24T14:15:22Z"
}

サブネットの更新

指定した仮想ネットワーク内のサブネット情報を更新します。

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想ネットワークの一意なID

subnetId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

サブネットの一意なID

Request Body schema: application/json
required
name
required
string

サブネットの名前

cidr
required
string^(\d{1,3}\.){3}\d{1,3}/([0-9]|[12][0-9]|3[0-2...

CIDR形式のサブネットアドレス

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "cidr": "192.168.1.0/24"
}

Response samples

Content type
application/json
{
  • "parent": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "cidr": "10.0.0.0/24",
  • "createdAt": "2019-08-24T14:15:22Z"
}

サブネットの部分更新

指定した仮想ネットワーク内のサブネット情報を更新します。

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想ネットワークの一意なID

subnetId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

サブネットの一意なID

Request Body schema: application/json
required
name
string

サブネットの名前

cidr
string^(\d{1,3}\.){3}\d{1,3}/([0-9]|[12][0-9]|3[0-2...

CIDR形式のサブネットアドレス

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "cidr": "192.168.1.0/24"
}

Response samples

Content type
application/json
{
  • "parent": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "cidr": "10.0.0.0/24",
  • "createdAt": "2019-08-24T14:15:22Z"
}

サブネットの削除

指定した仮想ネットワーク内のサブネットを削除します。

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想ネットワークの一意なID

subnetId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

サブネットの一意なID

Responses

Response samples

Content type
application/json
{}

サブネットに接続されている仮想マシンの一覧取得

指定した仮想ネットワーク内のサブネットに接続されている仮想マシンの一覧を取得します。

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

仮想ネットワークの一意なID

subnetId
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

サブネットの一意なID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Agent Images

Agent イメージ操作（テンプレート化、削除など）

イメージをテンプレートに変換

アップロードされた OS イメージをテンプレートに変換する

Request Body schema: application/json
required
id
required
string

テンプレート VM の ID（例: 9000）

name
required
string

テンプレート VM 名（例: template-base）

image_name
required
string

アップロード済みイメージファイル名

Responses

Request samples

Content type
application/json
{
  • "id": "9000",
  • "name": "template-base",
  • "image_name": "upload.img"
}

Response samples

Content type
application/json
{
  • "taskId": "task-abc123",
  • "message": "イメージのテンプレート化を開始しました"
}

イメージを削除

アップロードされた OS イメージを削除する

Request Body schema: application/json
required
storage_id
required
string

ストレージ ID（例: local）

image_name
required
string

イメージファイル名

Responses

Request samples

Content type
application/json
{
  • "storage_id": "local",
  • "image_name": "upload.img"
}

Response samples

Content type
application/json
{
  • "message": "イメージを削除しました"
}

Agent Nodes

Agent ノード操作（追加など）

ノードを追加

新しいノードをクラスタに追加する。ノードの IP アドレスを指定して認識させる

Request Body schema: application/json
required
node_name
required
string

新ノード名

ip_address
required
string <ipv4>

新ノードのプライベート IP アドレス

master_ip
required
string <ipv4>

マスターノードの IP アドレス

Responses

Request samples

Content type
application/json
{
  • "node_name": "pve-node-03",
  • "ip_address": "192.168.3.10",
  • "master_ip": "192.168.3.5"
}

Response samples

Content type
application/json
{
  • "taskId": "task-def456",
  • "nodeId": "node-003",
  • "message": "ノードの追加を開始しました"
}

Agent Storage Pools

Agent ストレージプール操作（作成、更新、マウントなど）

ストレージプールを新規作成

LVM または ZFS ストレージプールを新規作成する

Request Body schema: application/json
required
pool_name
required
string

ZFS プール名（例: poka）

device
required
string

デバイスパス（例: /dev/sdb）

storage_name
required
string

Proxmox での表示名

node_name
required
string

対象ノード名（例: test01）

content
Array of strings
Default: ["images","rootdir"]
Items Enum: "images" "rootdir"

コンテンツタイプ

comment
string

プール説明・UUID

Responses

Request samples

Content type
application/json
{
  • "pool_name": "poka",
  • "device": "/dev/sdb",
  • "storage_name": "poka",
  • "node_name": "test01",
  • "content": [
    ],
  • "comment": "UUID:550e8400-e29b-41d4-a716-446655440000"
}

Response samples

Content type
application/json
{
  • "taskId": "task-ghi789",
  • "poolId": "storage-poka",
  • "poolName": "poka",
  • "message": "ストレージプールの作成を開始しました"
}

ストレージプール設定を更新

NFS サーバーの共有設定など、ストレージプールの設定を更新する

path Parameters
poolId
required
string

更新するストレージプール ID

Request Body schema: application/json
required
pool_name
required
string

ZFS プール名

network
required
string

公開ネットワーク（例: 192.168.3.0/24）

read_write
boolean
Default: true

RW 権限の有無

root_squash
boolean
Default: false

ルートスクワッシュ設定

Responses

Request samples

Content type
application/json
{
  • "pool_name": "poka",
  • "network": "192.168.3.0/24",
  • "read_write": true,
  • "root_squash": false
}

Response samples

Content type
application/json
{
  • "poolId": "storage-poka",
  • "poolName": "poka",
  • "message": "ストレージプール設定を更新しました"
}

リモートストレージプールをマウント

別のノードで公開されている NFS ストレージプールを、現在のノードにマウントする

path Parameters
poolId
required
string

マウント対象のリモートストレージプール ID

Request Body schema: application/json
required
storage_name
required
string

ストレージ表示名

server_ip
required
string <ipv4>

NFS サーバーの IP アドレス

export_path
required
string

エクスポートパス（例: /poka）

content
required
Array of strings
Items Enum: "images" "rootdir"

コンテンツタイプ

node_name
required
Array of strings

登録対象ノード名の配列

Responses

Request samples

Content type
application/json
{
  • "storage_name": "remote-poka",
  • "server_ip": "192.168.3.50",
  • "export_path": "/poka",
  • "content": [
    ],
  • "node_name": [
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "task-jkl012",
  • "message": "リモートストレージプールのマウントを開始しました"
}

Summary

ノード/各VMのメトリクス履歴データを取得

ノード/各VMのメトリクス履歴データを取得

Authorizations:
BearerAuth
query Parameters
admin
required
boolean

管理者権限フラグ、trueの場合はノードのメトリクス履歴データ、falseの場合はユーザに割り当てられたVMのメトリクス履歴データを返す

Responses

Response samples

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

ノード/各VMのメトリクスデータを取得

ノード/各VMのメトリクスデータを取得

Authorizations:
BearerAuth
query Parameters
admin
required
boolean

管理者権限フラグ、trueの場合はノードのメトリクスデータ、falseの場合はユーザに割り当てられたVMのメトリクスデータを返す

Responses

Response samples

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

Backup

バックアップ一覧の取得

ユーザのバックアップのリストを取得します。

Authorizations:
BearerAuth
query Parameters
scope
string
Enum: "mine" "all"

表示範囲(mine=自分のもの, all=全て(管理者のみ)、指定のない場合はmine。)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

バックアップの作成

新しいバックアップを作成します。

Authorizations:
BearerAuth
Request Body schema: application/json
required
targetVirtualMachineId
required
string <uuid>

バックアップ対象の仮想マシンのID

targetStorageId
required
string <uuid>

バックアップ対象の仮想ストレージのID

name
required
string

バックアップの名前

description
string

バックアップの説明

Responses

Request samples

Content type
application/json
{
  • "targetVirtualMachineId": "1cb6727e-4150-49df-99e2-fd507e7642bd",
  • "targetStorageId": "c13ef496-ac65-4a92-bd47-9ffc94018167",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "size": 0,
  • "targetStorage": {
    },
  • "targetVirtualMachine": {
    }
}

バックアップの詳細取得

指定したIDのバックアップの詳細情報を取得します。

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

バックアップの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "size": 0,
  • "targetStorage": {
    },
  • "targetVirtualMachine": {
    }
}

バックアップの更新

指定したIDのバックアップ情報を更新します。

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

バックアップの一意なID

Request Body schema: application/json
required
name
required
string

バックアップの名前

description
string

バックアップの説明

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "size": 0,
  • "targetStorage": {
    },
  • "targetVirtualMachine": {
    }
}

バックアップの部分更新

指定したIDのバックアップ情報を部分的に更新します。

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

バックアップの一意なID

Request Body schema: application/json
required
name
string

バックアップの名前

description
string

バックアップの説明

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "size": 0,
  • "targetStorage": {
    },
  • "targetVirtualMachine": {
    }
}

バックアップの削除

指定したIDのバックアップを削除します。

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

バックアップの一意なID

Responses

Response samples

Content type
application/json
{}

バックアップを仮想マシンに復元する

指定したIDのバックアップを、バックアップ元の仮想マシンに復元します。復元先の仮想マシンが削除されている場合、復元は失敗します。

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

バックアップの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "running",
  • "node": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "securityGroups": [
    ],
  • "storages": [
    ],
  • "networkInterfaces": [
    ],
  • "cpuUtilization": 0.55,
  • "memoryUtilization": 0.7,
  • "storageUtilization": 0.4,
  • "cpuCore": 0,
  • "memorySize": 0
}

Snapshot

スナップショット一覧の取得

すべてのスナップショットのリストを取得します。

Authorizations:
BearerAuth
query Parameters
scope
string
Enum: "mine" "all"

表示範囲(mine=自分のもの, all=全て(管理者のみ)、指定のない場合はmine。)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

スナップショットの作成

新しいスナップショットを作成します。

Authorizations:
BearerAuth
Request Body schema: application/json
required
name
required
string

スナップショットの名前

description
string

スナップショットの説明

targetVmId
required
string <uuid>

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

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "targetVmId": "ebe8256d-aed9-4915-b339-5dd055480271"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "targetVirtualMachine": {
    }
}

スナップショットの詳細取得

指定したIDのスナップショットの詳細情報を取得します。

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

スナップショットの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "targetVirtualMachine": {
    }
}

スナップショットの更新

指定したIDのスナップショット情報を更新します。

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

スナップショットの一意なID

Request Body schema: application/json
required
name
required
string

スナップショットの名前

description
required
string

スナップショットの説明

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "targetVirtualMachine": {
    }
}

スナップショットの部分更新

指定したIDのスナップショット情報を部分的に更新します。

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

スナップショットの一意なID

Request Body schema: application/json
required
name
string

スナップショットの名前

description
string

スナップショットの説明

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "targetVirtualMachine": {
    }
}

スナップショットの削除

指定したIDのスナップショットを削除します。

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

スナップショットの一意なID

Responses

Response samples

Content type
application/json
{}

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

指定したIDのスナップショットを、スナップショット元の仮想マシンに復元します。復元先の仮想マシンが削除されている場合、復元は失敗します。

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>
Example: 12fbed88-2dc4-4537-af98-f1f796046d16

スナップショットの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "running",
  • "node": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "owner": {
    },
  • "securityGroups": [
    ],
  • "storages": [
    ],
  • "networkInterfaces": [
    ],
  • "cpuUtilization": 0.55,
  • "memoryUtilization": 0.7,
  • "storageUtilization": 0.4,
  • "cpuCore": 0,
  • "memorySize": 0
}