API docs by Redocly

KCI API (0.0.1)

Download OpenAPI specification:

KCI API documentation

VirtualMachine

バックアップ一覧の取得

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

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

バックアップの作成

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

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

バックアップの名前

targetStorageId
required
string <uuid>

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

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "targetStorageId": "c13ef496-ac65-4a92-bd47-9ffc94018167"
}

Response samples

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

バックアップの削除

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

Authorizations:
BearerAuth
query Parameters
backupId
required
string <uuid>

バックアップの一意なID

Responses

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

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

Authorizations:
BearerAuth

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",
  • "targetVirtualMachine": {
    }
}

スナップショットの削除

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

Authorizations:
BearerAuth
query Parameters
snapshotId
required
string <uuid>

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

Responses

仮想マシン一覧の取得

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

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

仮想マシンの作成

新しい仮想マシンを作成します。

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

仮想マシンの名前

instanceTypeId
string <uuid>

使用するインスタンスタイプのID

cpuCore
integer

仮想マシンに割り当てるCPUコア数（instanceTypeIdが指定されていない場合に必須）

memorySize
integer

仮想マシンに割り当てるメモリサイズ（バイト単位、instanceTypeIdが指定されていない場合に必須）

subnetId
required
string <uuid>

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

publicKey
string

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

imageId
required
string <uuid>

使用する仮想マシンイメージのID

middleWareId
string <uuid>

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

nodeId
required
string <uuid>

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

required
Array of objects

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

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

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

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "instanceTypeId": "41e36058-8403-4086-a9b8-39cb5bc9cb98",
  • "cpuCore": 0,
  • "memorySize": 0,
  • "subnetId": "1f232bf0-7b90-456e-b9b0-38d9fea4171a",
  • "publicKey": "string",
  • "imageId": "bbefe473-c66a-4040-85cf-1c7e6f0b3830",
  • "middleWareId": "a9b6b690-7937-4a32-a039-3b3c209e0345",
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177",
  • "storages": [
    ],
  • "securityGroupIds": [
    ]
}

Response samples

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

仮想マシンの詳細取得

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

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>

仮想マシンの一意なID

Responses

Response samples

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

仮想マシンの更新

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

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>

仮想マシンの一意なID

Request Body schema: application/json
required
name
string

仮想マシンの名前

instanceTypeId
string <uuid>

使用するインスタンスタイプのID

cpuCore
integer

仮想マシンに割り当てるCPUコア数

memorySize
integer

仮想マシンに割り当てるメモリサイズ（バイト単位）

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

仮想マシンに関連付けられたセキュリティグループのIDリスト

Array of objects (AttachedStorage)

アタッチされたストレージのリスト

Array of objects (NetworkInterface)

アタッチされたネットワークインターフェースのリスト

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "instanceTypeId": "41e36058-8403-4086-a9b8-39cb5bc9cb98",
  • "cpuCore": 0,
  • "memorySize": 0,
  • "securityGroupIds": [
    ],
  • "attachedStorages": [
    ],
  • "attachedNics": [
    ]
}

Response samples

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

仮想マシンの削除

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

Authorizations:
BearerAuth
path Parameters
vmId
required
string <uuid>

仮想マシンの一意なID

Responses

User

ユーザ一覧の取得

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

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ユーザの作成

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

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

ユーザの名前

email
required
string <email>

ユーザのメールアドレス

password
required
string <password>

ユーザのパスワード

useTOTP
required
boolean

TOTPを使用するかどうかを示すフラグ

isAdmin
required
boolean

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

maxCpuCore
integer

ユーザが使用できる最大CPUコア数

maxMemorySize
integer

ユーザが使用できる最大メモリサイズ（バイト単位）

maxStorageSize
integer

ユーザが使用できる最大ストレージサイズ（バイト単位）

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "password": "pa$$word",
  • "useTOTP": true,
  • "isAdmin": true,
  • "maxCpuCore": 0,
  • "maxMemorySize": 0,
  • "maxStorageSize": 0
}

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",
  • "TotpInfo": {
    }
}

ユーザの詳細取得

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

Authorizations:
BearerAuth
path Parameters
userId
required
string <uuid>

ユーザの一意な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",
  • "TotpInfo": {
    }
}

ユーザの更新

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

Authorizations:
BearerAuth
path Parameters
userId
required
string <uuid>

ユーザの一意なID

Request Body schema: application/json
required
name
string

ユーザの名前

email
string <email>

ユーザのメールアドレス

maxCpuCore
integer

ユーザが使用できる最大CPUコア数

maxMemorySize
integer

ユーザが使用できる最大メモリサイズ（バイト単位）

maxStorageSize
integer

ユーザが使用できる最大ストレージサイズ（バイト単位）

isAdmin
boolean

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

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "maxCpuCore": 0,
  • "maxMemorySize": 0,
  • "maxStorageSize": 0,
  • "isAdmin": true
}

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",
  • "TotpInfo": {
    }
}

ユーザの削除

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

Authorizations:
BearerAuth
path Parameters
userId
required
string <uuid>

ユーザの一意なID

Responses

Users

自分のユーザ情報取得

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

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",
  • "TotpInfo": {
    }
}

Image

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

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

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

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

Authorizations:
BearerAuth
Request Body schema: multipart/form-data
required
name
required
string

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

description
string

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

file
required
string <binary>

アップロードする仮想マシンイメージファイル(base64エンコードされたバイナリデータ)

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
}

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

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

Authorizations:
BearerAuth
path Parameters
imageId
required
string <uuid>

仮想マシンイメージの一意な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
}

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

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

Authorizations:
BearerAuth
path Parameters
imageId
required
string <uuid>

仮想マシンイメージの一意な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",
  • "size": 0
}

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

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

Authorizations:
BearerAuth
path Parameters
imageId
required
string <uuid>

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

Responses

ミドルウェア一覧の取得

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

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

CPUコア数

memorySize
required
integer

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

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "cpuCore": 0,
  • "memorySize": 0
}

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>

インスタンスタイプの一意な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>

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

Request Body schema: application/json
required
name
string

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

cpuCore
integer

CPUコア数

memorySize
integer

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

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "cpuCore": 0,
  • "memorySize": 0
}

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>

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

Responses

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"
}

ユーザのログイン

ユーザのメールアドレスとパスワードを使用してログインします。トークンはCookieに保存されます。

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
{
  • "message": "string"
}

PhysicalNode

物理ノード一覧の取得

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

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

物理ノードの追加

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

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

物理ノードの名前

ipAddress
required
string <ipv4>

物理ノードのIPアドレス

isAdmin
required
boolean

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

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "ipAddress": "192.168.0.1",
  • "isAdmin": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "ipAddress": "192.168.0.1",
  • "status": "active",
  • "isAdmin": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "cpuUtilization": 0.75,
  • "memoryUtilization": 0.6,
  • "storageUtilization": 0.8
}

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

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

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

物理ノードの詳細取得

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

Authorizations:
BearerAuth
path Parameters
nodeId
required
string <uuid>

物理ノードの一意なID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "ipAddress": "192.168.0.1",
  • "status": "active",
  • "isAdmin": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "cpuUtilization": 0.75,
  • "memoryUtilization": 0.6,
  • "storageUtilization": 0.8
}

物理ノードの更新

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

Authorizations:
BearerAuth
path Parameters
nodeId
required
string <uuid>

物理ノードの一意なID

Request Body schema: application/json
required
isAdmin
boolean

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

Responses

Request samples

Content type
application/json
{
  • "isAdmin": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "ipAddress": "192.168.0.1",
  • "status": "active",
  • "isAdmin": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "cpuUtilization": 0.75,
  • "memoryUtilization": 0.6,
  • "storageUtilization": 0.8
}

物理ノードの削除

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

Authorizations:
BearerAuth
path Parameters
nodeId
required
string <uuid>

物理ノードの一意なID

Responses

SecurityGroup

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

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

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

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

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

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

description
string

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

Array of objects (SecurityRuleCreateRequest)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "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",
  • "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

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

Array of objects (SecurityRule)

Responses

Request samples

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

Response samples

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

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

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

Authorizations:
BearerAuth
path Parameters
groupId
required
string <uuid>

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

Responses

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

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

Authorizations:
BearerAuth
path Parameters
groupId
required
string <uuid>

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

Request Body schema: application/json
required
name
required
string

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

ruleType
required
string
Enum: "inbound" "outbound"

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

port
required
integer

適用されるポート番号

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

適用されるプロトコル

targetIp
required
string <ipv4>

ターゲットIPアドレス

action
required
string
Enum: "allow" "deny"

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

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "ruleType": "inbound",
  • "port": 22,
  • "protocol": "tcp",
  • "targetIp": "10.0.0.0/16",
  • "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"
}

StoragePool

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

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

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ストレージプールの作成

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

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

ストレージプールの名前

nodeId
required
string <uuid>

ストレージプールを作成する物理ノードのID

size
required
integer

ストレージプールのサイズ（バイト単位）

devFile
required
string

ストレージデバイスのパス

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177",
  • "size": 0,
  • "devFile": "/dev/sdb"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "totalSize": 0,
  • "usedSize": 0,
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177",
  • "devFile": "/dev/sdb"
}

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

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

Authorizations:
BearerAuth
path Parameters
poolId
required
string <uuid>

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

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "totalSize": 0,
  • "usedSize": 0,
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177",
  • "devFile": "/dev/sdb"
}

ストレージプールの削除

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

Authorizations:
BearerAuth
path Parameters
poolId
required
string <uuid>

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

Responses

デバイス一覧の取得

指定した物理ノードのローカルストレージプールに使用可能なデバイスのリストを取得します。

path Parameters
nodeId
required
string <uuid>

物理ノードの一意なID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ネットワークストレージプール一覧の取得

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

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ストレージプールの作成

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

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

ストレージプールの名前

size
required
integer

ストレージプールのサイズ（バイト単位）

localStorageId
required
string <uuid>

使用するローカルストレージプールのID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "size": 0,
  • "localStorageId": "a21cd120-32ac-4c56-8bcc-38ac7d942692"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "totalSize": 0,
  • "usedSize": 0,
  • "localStoragePoolId": "1d61d065-78ed-4187-9836-48e31d916b77"
}

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

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

Authorizations:
BearerAuth
path Parameters
poolId
required
string <uuid>

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

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "totalSize": 0,
  • "usedSize": 0,
  • "localStoragePoolId": "1d61d065-78ed-4187-9836-48e31d916b77"
}

ストレージプールの削除

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

Authorizations:
BearerAuth
path Parameters
poolId
required
string <uuid>

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

Responses

VirtualNetwork

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

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

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

仮想ネットワークの作成

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

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

仮想ネットワークの名前

cidr
required
string

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

Responses

Request samples

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

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",
  • "subnets": [
    ],
  • "inboundTraffic": 125000,
  • "outboundTraffic": 98000
}

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

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

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>

仮想ネットワークの一意な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",
  • "subnets": [
    ],
  • "inboundTraffic": 125000,
  • "outboundTraffic": 98000
}

仮想ネットワークの更新

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

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>

仮想ネットワークの一意な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",
  • "subnets": [
    ],
  • "inboundTraffic": 125000,
  • "outboundTraffic": 98000
}

仮想ネットワークの削除

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

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>

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

Responses

サブネットの追加

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

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>

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

Request Body schema: application/json
required
name
required
string

サブネットの名前

cidr
required
string

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

possibleExternalConnection
required
boolean

外部接続が可能かどうかを示すフラグ

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "cidr": "10.0.0.0/16",
  • "possibleExternalConnection": true
}

Response samples

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

サブネットの更新

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

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>

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

subnetId
required
string <uuid>

サブネットの一意なID

Request Body schema: application/json
required
name
string

サブネットの名前

cidr
string

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

possibleExternalConnection
boolean

外部接続が可能かどうかを示すフラグ

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "cidr": "10.0.0.0/16",
  • "possibleExternalConnection": true
}

Response samples

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

サブネットの削除

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

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid>

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

subnetId
required
string <uuid>

サブネットの一意なID

Responses

Portfolio

ポートフォリオ一覧の取得

すべてのポートフォリオのリストを取得します。

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ポートフォリオの作成

新しいポートフォリオを作成します。

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

ポートフォリオのタイトル

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "viewCount24Hour": 0,
  • "viewCount7Day": 0
}

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

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

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>

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

Responses

Response samples

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

スナップショットの削除

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

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>

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

Responses