schemas
schemas: {
AttachedSecurityGroupBulkRequest: {
add?: { id?: string }[];
remove?: string[];
};
BackupCreateOnly: {
targetStorageId?: string;
targetVirtualMachineId?: string;
};
BackupCreateRequest: {
targetStorageId?: string;
targetVirtualMachineId?: string;
} & { targetStorageId: string; targetVirtualMachineId: string } & {
description?: string;
name?: string;
} & { name: string };
BackupPatchRequest: { description?: string; name?: string };
BackupPutRequest: WithRequired<
{ description?: string; name?: string },
"name",
>;
BackupResponse: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
size: number;
targetStorage?: {
createdAt: string;
devicePath: string;
id: string;
name: string;
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
size: number;
};
targetVirtualMachine?: {
cpuCore: number;
cpuUtilization?: number;
createdAt: string;
id: string;
memorySize: number;
memoryUtilization?: number;
name: string;
networkInterfaces: {
id: string;
ipAddress: string;
macAddress: string;
name: string;
subnet: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
};
}[];
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active"
| "inactive";
storageUtilization?: number;
};
owner: { id: string; name: string };
securityGroups: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
rules: {
action?: "allow" | "deny";
createdAt: string;
id: string;
name: string;
port?: number;
protocol: "tcp" | "udp" | "icmp" | "any";
ruleType: "inbound" | "outbound";
targetIp: string;
}[];
}[];
status: "stopped"
| "running"
| "suspended";
storages: {
createdAt: string;
devicePath: string;
id: string;
name: string;
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
size: number;
}[];
storageUtilization?: number;
};
};
BackupUpdatable: { description?: string; name?: string };
DeviceResponse: { deviceName: string; devicePath: string; size: number };
ErrorResponse: {
detail?: string;
instance?: string;
status?: number;
title?: string;
type?: string;
};
HistoryData: {
cpuHistory: { timestamp: number; value: number }[];
id: string;
memHistory: { timestamp: number; value: number }[];
name: string;
networkINHistory: { timestamp: number; value: number }[];
networkOUTHistory: { timestamp: number; value: number }[];
totalCpu: number;
totalMemory: number;
};
HistoryItem: { timestamp: number; value: number };
ImageClientUpdatable: { description?: string; name?: string };
ImageCreateOnly: { storagePoolId?: string };
ImageCreateRequest: { description?: string; name?: string } & {
name: string;
} & { storagePoolId?: string } & { storagePoolId: string };
ImagePatchRequest: { description?: string; name?: string };
ImagePutRequest: { description?: string; name: string };
ImageResponse: {
createdAt: string;
description?: string;
id: string;
name: string;
size: number;
storagePool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
};
InstanceTypeCreateRequest: {
cpuCore: number;
memorySize: number;
name: string;
};
InstanceTypePatchRequest: {
cpuCore?: number;
memorySize?: number;
name?: string;
};
InstanceTypePutRequest: WithRequired<
{ cpuCore?: number; memorySize?: number; name?: string },
"name" | "cpuCore" | "memorySize",
>;
InstanceTypeResponse: {
cpuCore: number;
createdAt: string;
id: string;
memorySize: number;
name: string;
};
InstanceTypeUpdatable: {
cpuCore?: number;
memorySize?: number;
name?: string;
};
LoginRequest: { email: string; password: string };
LoginResponse: { refreshToken: string; token: string };
MiddlewareResponse: { id: string; name: string };
NetworkInterfaceBulkRequest: unknown;
NetworkInterfaceCreateRequest: WithRequired<
{ name?: string; subnetId?: string },
"name" | "subnetId",
>;
NetworkInterfacePatchRequest: { name?: string; subnetId?: string };
NetworkInterfacePutRequest: WithRequired<
{ name?: string; subnetId?: string },
"name" | "subnetId",
>;
NetworkInterfaceResponse: {
id: string;
ipAddress: string;
macAddress: string;
name: string;
subnet: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
};
};
NetworkInterfaceUpdatable: { name?: string; subnetId?: string };
NodeCandidateResponse: { ipAddress: string; name: string };
NodeCreateOnly: { ipAddress: string; rootPassword: string };
NodeCreateRequest: { ipAddress: string; rootPassword: string } & {
isAdmin?: boolean;
name?: string;
};
NodePatchRequest: { isAdmin?: boolean; name?: string };
NodePutRequest: { isAdmin: boolean; name: string };
NodeResponse: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
NodeUpdatable: { isAdmin?: boolean; name?: string };
OwnerInfo: { id: string; name: string };
PasswordChangeRequest: { currentPassword: string; newPassword: string };
RefreshRequest: { refreshToken: string };
SecurityGroupCreateOnly: {
rules: WithRequired<
{
action?: "allow"
| "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
},
"name"
| "port"
| "action"
| "ruleType"
| "protocol"
| "targetIp",
>[];
};
SecurityGroupCreateRequest: { description?: string; name?: string } & {
name: string;
} & {
rules: WithRequired<
{
action?: "allow"
| "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
},
"name"
| "port"
| "action"
| "ruleType"
| "protocol"
| "targetIp",
>[];
} & {
rules: WithRequired<
{
action?: "allow"
| "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
},
"name"
| "port"
| "action"
| "ruleType"
| "protocol"
| "targetIp",
>[];
};
SecurityGroupPatchRequest: { description?: string; name?: string };
SecurityGroupPutRequest: WithRequired<
{ description?: string; name?: string },
"name" | "description",
>;
SecurityGroupResponse: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
rules: {
action?: "allow" | "deny";
createdAt: string;
id: string;
name: string;
port?: number;
protocol: "tcp" | "udp" | "icmp" | "any";
ruleType: "inbound" | "outbound";
targetIp: string;
}[];
};
SecurityGroupUpdatable: { description?: string; name?: string };
SecurityRuleBulkRequest: {
add?: WithRequired<
{
action?: "allow"
| "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
},
"name"
| "port"
| "action"
| "ruleType"
| "protocol"
| "targetIp",
>[];
patch?: {
data: {
action?: "allow" | "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
};
id: string;
}[];
remove?: string[];
};
SecurityRuleCreateRequest: WithRequired<
{
action?: "allow"
| "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
},
"name"
| "port"
| "action"
| "ruleType"
| "protocol"
| "targetIp",
>;
SecurityRulePatchRequest: {
action?: "allow" | "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
} & { id?: string };
SecurityRulePutRequest: WithRequired<
{
action?: "allow"
| "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
},
"name"
| "port"
| "action"
| "ruleType"
| "protocol"
| "targetIp",
>;
SecurityRuleResponse: {
action?: "allow" | "deny";
createdAt: string;
id: string;
name: string;
port?: number;
protocol: "tcp" | "udp" | "icmp" | "any";
ruleType: "inbound" | "outbound";
targetIp: string;
};
SecurityRuleUpdatable: {
action?: "allow"
| "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
};
SnapshotCreateOnly: { targetVmId: string };
SnapshotCreateRequest: { description?: string; name?: string } & {
name: string;
} & { targetVmId: string };
SnapshotPatchRequest: { description?: string; name?: string };
SnapshotPutRequest: WithRequired<
{ description?: string; name?: string },
"name" | "description",
>;
SnapshotResponse: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
targetVirtualMachine: {
cpuCore: number;
cpuUtilization?: number;
createdAt: string;
id: string;
memorySize: number;
memoryUtilization?: number;
name: string;
networkInterfaces: {
id: string;
ipAddress: string;
macAddress: string;
name: string;
subnet: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
};
}[];
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active"
| "inactive";
storageUtilization?: number;
};
owner: { id: string; name: string };
securityGroups: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
rules: {
action?: "allow" | "deny";
createdAt: string;
id: string;
name: string;
port?: number;
protocol: "tcp" | "udp" | "icmp" | "any";
ruleType: "inbound" | "outbound";
targetIp: string;
}[];
}[];
status: "stopped"
| "running"
| "suspended";
storages: {
createdAt: string;
devicePath: string;
id: string;
name: string;
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
size: number;
}[];
storageUtilization?: number;
};
};
SnapshotUpdatable: { description?: string; name?: string };
StorageBulkRequest: {
add?: (
{ name?: string } & { name: string } & {
backupId?: string;
poolId: string;
size: number;
}
)[];
patch?: { data: { name?: string }; id: string }[];
remove?: string[];
};
StorageCreateOnly: { backupId?: string; poolId: string; size: number };
StorageCreateRequest: { name?: string } & { name: string } & {
backupId?: string;
poolId: string;
size: number;
};
StoragePatchRequest: { name?: string };
StoragePoolCreateOnly: { devicePath: string; nodeId: string };
StoragePoolCreateRequest: { devicePath: string; nodeId: string } & {
hasNetworkAccess?: boolean;
name?: string;
} & { hasNetworkAccess: boolean; name: string };
StoragePoolPatchRequest: { hasNetworkAccess?: boolean; name?: string };
StoragePoolPutRequest: WithRequired<
{ hasNetworkAccess?: boolean; name?: string },
"name" | "hasNetworkAccess",
>;
StoragePoolResponse: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
StoragePoolUpdatable: { hasNetworkAccess?: boolean; name?: string };
StoragePutRequest: WithRequired<{ name?: string }, "name">;
StorageResponse: {
createdAt: string;
devicePath: string;
id: string;
name: string;
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
size: number;
};
StorageUpdatable: { name?: string };
SubnetBulkRequest: {
add?: WithRequired<{ cidr?: string; name?: string }, "name" | "cidr">[];
patch?: { data: { cidr?: string; name?: string }; id: string }[];
remove?: string[];
};
SubnetCreateRequest: WithRequired<
{ cidr?: string; name?: string },
"name" | "cidr",
>;
SubnetPatchRequest: { cidr?: string; name?: string } & Record<
string,
never,
>;
SubnetPutRequest: WithRequired<
{ cidr?: string; name?: string },
"name" | "cidr",
>;
SubnetResponse: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
};
SubnetUpdatable: { cidr?: string; name?: string };
Summary: {
totalCpu: number;
totalMemory: number;
totalStorage: number;
usedCpu: number;
usedMemory: number;
usedStorage: number;
};
SummaryHistoryResponse: {
data: {
cpuHistory: { timestamp: number; value: number }[];
id: string;
memHistory: { timestamp: number; value: number }[];
name: string;
networkINHistory: { timestamp: number; value: number }[];
networkOUTHistory: { timestamp: number; value: number }[];
totalCpu: number;
totalMemory: number;
}[];
};
SummaryResponse: {
clusterSummary: {
totalCpu: number;
totalMemory: number;
totalStorage: number;
usedCpu: number;
usedMemory: number;
usedStorage: number;
};
};
TotpInfo: { secret: string; uri: string };
UserCreateOnly: { password: string };
UserCreateRequest: { password: string } & {
email?: string;
isAdmin?: boolean;
isImageAdmin?: boolean;
isInstanceTypeAdmin?: boolean;
isNetworkAdmin?: boolean;
isNodeAdmin?: boolean;
isSecurityGroupAdmin?: boolean;
isVirtualMachineAdmin?: boolean;
maxCpuCore?: number;
maxMemorySize?: number;
maxStorageSize?: number;
name?: string;
} & {
email: string;
isAdmin: boolean;
maxCpuCore: number;
maxMemorySize: number;
maxStorageSize: number;
name: string;
};
UserPatchRequest: {
email?: string;
isAdmin?: boolean;
isImageAdmin?: boolean;
isInstanceTypeAdmin?: boolean;
isNetworkAdmin?: boolean;
isNodeAdmin?: boolean;
isSecurityGroupAdmin?: boolean;
isVirtualMachineAdmin?: boolean;
maxCpuCore?: number;
maxMemorySize?: number;
maxStorageSize?: number;
name?: string;
};
UserPutRequest: WithRequired<
{
email?: string;
isAdmin?: boolean;
isImageAdmin?: boolean;
isInstanceTypeAdmin?: boolean;
isNetworkAdmin?: boolean;
isNodeAdmin?: boolean;
isSecurityGroupAdmin?: boolean;
isVirtualMachineAdmin?: boolean;
maxCpuCore?: number;
maxMemorySize?: number;
maxStorageSize?: number;
name?: string;
},
| "name"
| "email"
| "isAdmin"
| "maxCpuCore"
| "maxMemorySize"
| "maxStorageSize"
| "isImageAdmin"
| "isInstanceTypeAdmin"
| "isVirtualMachineAdmin"
| "isNetworkAdmin"
| "isSecurityGroupAdmin"
| "isNodeAdmin",
>;
UserResponse: {
createdAt: string;
email: string;
id: string;
isAdmin: boolean;
isImageAdmin: boolean;
isInstanceTypeAdmin: boolean;
isNetworkAdmin: boolean;
isNodeAdmin: boolean;
isSecurityGroupAdmin: boolean;
isVirtualMachineAdmin: boolean;
lastLoginAt: string;
maxCpuCore?: number;
maxMemorySize?: number;
maxStorageSize?: number;
name: string;
totpInfo?: { secret: string; uri: string };
};
UserUpdatable: {
email?: string;
isAdmin?: boolean;
isImageAdmin?: boolean;
isInstanceTypeAdmin?: boolean;
isNetworkAdmin?: boolean;
isNodeAdmin?: boolean;
isSecurityGroupAdmin?: boolean;
isVirtualMachineAdmin?: boolean;
maxCpuCore?: number;
maxMemorySize?: number;
maxStorageSize?: number;
name?: string;
};
VirtualMachineCreateOnly: {
imageId: string;
middlewareId?: string;
nodeId: string;
publicKey: string;
securityGroupIds: string[];
storages: {
backupId?: string;
name: string;
poolId: string;
size: number;
}[];
subnetIds: string[];
};
VirtualMachineCreateRequest: {
imageId: string;
middlewareId?: string;
nodeId: string;
publicKey: string;
securityGroupIds: string[];
storages: {
backupId?: string;
name: string;
poolId: string;
size: number;
}[];
subnetIds: string[];
} & {
name?: string;
spec?: { instanceTypeId: string }
| { cpu: number; memory: number };
} & {
name: string;
spec: { instanceTypeId: string }
| { cpu: number; memory: number };
};
VirtualMachinePatchRequest: {
name?: string;
spec?: { instanceTypeId: string }
| { cpu: number; memory: number };
};
VirtualMachinePutRequest: WithRequired<
{
name?: string;
spec?: { instanceTypeId: string }
| { cpu: number; memory: number };
},
"name",
>;
VirtualMachineResponse: {
cpuCore: number;
cpuUtilization?: number;
createdAt: string;
id: string;
memorySize: number;
memoryUtilization?: number;
name: string;
networkInterfaces: {
id: string;
ipAddress: string;
macAddress: string;
name: string;
subnet: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
};
}[];
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active"
| "inactive";
storageUtilization?: number;
};
owner: { id: string; name: string };
securityGroups: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
rules: {
action?: "allow" | "deny";
createdAt: string;
id: string;
name: string;
port?: number;
protocol: "tcp" | "udp" | "icmp" | "any";
ruleType: "inbound" | "outbound";
targetIp: string;
}[];
}[];
status: "stopped"
| "running"
| "suspended";
storages: {
createdAt: string;
devicePath: string;
id: string;
name: string;
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
size: number;
}[];
storageUtilization?: number;
};
VirtualMachineUpdatable: {
name?: string;
spec?: { instanceTypeId: string }
| { cpu: number; memory: number };
};
VirtualMachineWithCustomSpecUpdatable: { cpu: number; memory: number };
VirtualMachineWithInstanceTypeUpdatable: { instanceTypeId: string };
VirtualNetworkCreateOnly: {
cidr: string;
initialSubnets: WithRequired<
{ cidr?: string; name?: string },
"name" | "cidr",
>[];
};
VirtualNetworkCreateRequest: { name?: string } & { name: string } & {
cidr: string;
initialSubnets: WithRequired<
{ cidr?: string; name?: string },
"name" | "cidr",
>[];
};
VirtualNetworkPatchRequest: { name?: string };
VirtualNetworkPutRequest: WithRequired<{ name?: string }, "name">;
VirtualNetworkResponse: {
cidr: string;
createdAt: string;
id: string;
name: string;
owner: { id: string; name: string };
subnets: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
}[];
};
VirtualNetworkSummaryResponse: {
cidr: string;
createdAt: string;
id: string;
name: string;
};
VirtualNetworkUpdatable: { name?: string };
}
Type Declaration
AttachedSecurityGroupBulkRequest: { add?: { id?: string }[]; remove?: string[] }
Optionaladd?: { id?: string }[]
Optionalremove?: string[]
BackupCreateOnly: { targetStorageId?: string; targetVirtualMachineId?: string }
OptionaltargetStorageId?: string
OptionaltargetVirtualMachineId?: string
BackupCreateRequest: { targetStorageId?: string; targetVirtualMachineId?: string } & {
targetStorageId: string;
targetVirtualMachineId: string;
} & { description?: string; name?: string } & { name: string }
BackupPatchRequest: { description?: string; name?: string }
Optionaldescription?: string
Optionalname?: string
BackupPutRequest: WithRequired<{ description?: string; name?: string }, "name">
BackupResponse: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
size: number;
targetStorage?: {
createdAt: string;
devicePath: string;
id: string;
name: string;
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
size: number;
};
targetVirtualMachine?: {
cpuCore: number;
cpuUtilization?: number;
createdAt: string;
id: string;
memorySize: number;
memoryUtilization?: number;
name: string;
networkInterfaces: {
id: string;
ipAddress: string;
macAddress: string;
name: string;
subnet: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
};
}[];
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active"
| "inactive";
storageUtilization?: number;
};
owner: { id: string; name: string };
securityGroups: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
rules: {
action?: "allow" | "deny";
createdAt: string;
id: string;
name: string;
port?: number;
protocol: "tcp" | "udp" | "icmp" | "any";
ruleType: "inbound" | "outbound";
targetIp: string;
}[];
}[];
status: "stopped"
| "running"
| "suspended";
storages: {
createdAt: string;
devicePath: string;
id: string;
name: string;
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
size: number;
}[];
storageUtilization?: number;
};
}
createdAt: string
Optionaldescription?: string
id: string
name: string
owner: { id: string; name: string }
size: number
OptionaltargetStorage?: {
createdAt: string;
devicePath: string;
id: string;
name: string;
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
size: number;
}
createdAt: string
devicePath: string
id: string
name: string
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
}
availableSize: number
createdAt: string
hasNetworkAccess: boolean
id: string
name: string
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
}
OptionalcpuUtilization?: number
createdAt: string
id: string
ipAddress: string
isAdmin: boolean
OptionalmemoryUtilization?: number
name: string
status: "active" | "inactive"
OptionalstorageUtilization?: number
totalSize: number
usedSize: number
size: number
OptionaltargetVirtualMachine?: {
cpuCore: number;
cpuUtilization?: number;
createdAt: string;
id: string;
memorySize: number;
memoryUtilization?: number;
name: string;
networkInterfaces: {
id: string;
ipAddress: string;
macAddress: string;
name: string;
subnet: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
};
}[];
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active"
| "inactive";
storageUtilization?: number;
};
owner: { id: string; name: string };
securityGroups: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
rules: {
action?: "allow" | "deny";
createdAt: string;
id: string;
name: string;
port?: number;
protocol: "tcp" | "udp" | "icmp" | "any";
ruleType: "inbound" | "outbound";
targetIp: string;
}[];
}[];
status: "stopped"
| "running"
| "suspended";
storages: {
createdAt: string;
devicePath: string;
id: string;
name: string;
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
size: number;
}[];
storageUtilization?: number;
}
cpuCore: number
OptionalcpuUtilization?: number
createdAt: string
id: string
memorySize: number
OptionalmemoryUtilization?: number
name: string
networkInterfaces: {
id: string;
ipAddress: string;
macAddress: string;
name: string;
subnet: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
};
}[]
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
}
OptionalcpuUtilization?: number
createdAt: string
id: string
ipAddress: string
isAdmin: boolean
OptionalmemoryUtilization?: number
name: string
status: "active" | "inactive"
OptionalstorageUtilization?: number
owner: { id: string; name: string }
securityGroups: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
rules: {
action?: "allow" | "deny";
createdAt: string;
id: string;
name: string;
port?: number;
protocol: "tcp" | "udp" | "icmp" | "any";
ruleType: "inbound" | "outbound";
targetIp: string;
}[];
}[]
status: "stopped" | "running" | "suspended"
storages: {
createdAt: string;
devicePath: string;
id: string;
name: string;
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
size: number;
}[]
OptionalstorageUtilization?: number
BackupUpdatable: { description?: string; name?: string }
Optionaldescription?: string
Optionalname?: string
DeviceResponse: { deviceName: string; devicePath: string; size: number }
deviceName: string
devicePath: string
size: number
ErrorResponse: {
detail?: string;
instance?: string;
status?: number;
title?: string;
type?: string;
}
Optionaldetail?: string
Optionalinstance?: string
Optionalstatus?: number
Optionaltitle?: string
Optionaltype?: string
HistoryData: {
cpuHistory: { timestamp: number; value: number }[];
id: string;
memHistory: { timestamp: number; value: number }[];
name: string;
networkINHistory: { timestamp: number; value: number }[];
networkOUTHistory: { timestamp: number; value: number }[];
totalCpu: number;
totalMemory: number;
}
cpuHistory: { timestamp: number; value: number }[]
id: string
memHistory: { timestamp: number; value: number }[]
name: string
networkINHistory: { timestamp: number; value: number }[]
networkOUTHistory: { timestamp: number; value: number }[]
totalCpu: number
totalMemory: number
HistoryItem: { timestamp: number; value: number }
timestamp: number
value: number
ImageClientUpdatable: { description?: string; name?: string }
Optionaldescription?: string
Optionalname?: string
ImageCreateOnly: { storagePoolId?: string }
OptionalstoragePoolId?: string
ImageCreateRequest: { description?: string; name?: string } & { name: string } & {
storagePoolId?: string;
} & { storagePoolId: string }
ImagePatchRequest: { description?: string; name?: string }
Optionaldescription?: string
Optionalname?: string
ImagePutRequest: { description?: string; name: string }
Optionaldescription?: string
name: string
ImageResponse: {
createdAt: string;
description?: string;
id: string;
name: string;
size: number;
storagePool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
}
createdAt: string
Optionaldescription?: string
id: string
name: string
size: number
storagePool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
}
availableSize: number
createdAt: string
hasNetworkAccess: boolean
id: string
name: string
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
}
OptionalcpuUtilization?: number
createdAt: string
id: string
ipAddress: string
isAdmin: boolean
OptionalmemoryUtilization?: number
name: string
status: "active" | "inactive"
OptionalstorageUtilization?: number
totalSize: number
usedSize: number
InstanceTypeCreateRequest: { cpuCore: number; memorySize: number; name: string }
cpuCore: number
memorySize: number
name: string
InstanceTypePatchRequest: { cpuCore?: number; memorySize?: number; name?: string }
OptionalcpuCore?: number
OptionalmemorySize?: number
Optionalname?: string
InstanceTypePutRequest: WithRequired<
{ cpuCore?: number; memorySize?: number; name?: string },
"name" | "cpuCore" | "memorySize",
>
InstanceTypeResponse: {
cpuCore: number;
createdAt: string;
id: string;
memorySize: number;
name: string;
}
cpuCore: number
createdAt: string
id: string
memorySize: number
name: string
InstanceTypeUpdatable: { cpuCore?: number; memorySize?: number; name?: string }
OptionalcpuCore?: number
OptionalmemorySize?: number
Optionalname?: string
LoginRequest: { email: string; password: string }
email: string
password: string
LoginResponse: { refreshToken: string; token: string }
refreshToken: string
token: string
MiddlewareResponse: { id: string; name: string }
NetworkInterfaceBulkRequest: unknown
NetworkInterfaceCreateRequest: WithRequired<{ name?: string; subnetId?: string }, "name" | "subnetId">
NetworkInterfacePatchRequest: { name?: string; subnetId?: string }
Optionalname?: string
OptionalsubnetId?: string
NetworkInterfacePutRequest: WithRequired<{ name?: string; subnetId?: string }, "name" | "subnetId">
NetworkInterfaceResponse: {
id: string;
ipAddress: string;
macAddress: string;
name: string;
subnet: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
};
}
id: string
ipAddress: string
macAddress: string
name: string
subnet: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
}
cidr: string
createdAt: string
id: string
name: string
Optionalparent?: { cidr: string; createdAt: string; id: string; name: string }
cidr: string
createdAt: string
id: string
name: string
NetworkInterfaceUpdatable: { name?: string; subnetId?: string }
Optionalname?: string
OptionalsubnetId?: string
NodeCandidateResponse: { ipAddress: string; name: string }
ipAddress: string
name: string
NodeCreateOnly: { ipAddress: string; rootPassword: string }
ipAddress: string
rootPassword: string
NodeCreateRequest: { ipAddress: string; rootPassword: string } & {
isAdmin?: boolean;
name?: string;
}
NodePatchRequest: { isAdmin?: boolean; name?: string }
OptionalisAdmin?: boolean
Optionalname?: string
NodePutRequest: { isAdmin: boolean; name: string }
isAdmin: boolean
name: string
NodeResponse: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
}
OptionalcpuUtilization?: number
createdAt: string
id: string
ipAddress: string
isAdmin: boolean
OptionalmemoryUtilization?: number
name: string
status: "active" | "inactive"
OptionalstorageUtilization?: number
NodeUpdatable: { isAdmin?: boolean; name?: string }
OptionalisAdmin?: boolean
Optionalname?: string
OwnerInfo: { id: string; name: string }
PasswordChangeRequest: { currentPassword: string; newPassword: string }
currentPassword: string
newPassword: string
RefreshRequest: { refreshToken: string }
SecurityGroupCreateOnly: {
rules: WithRequired<
{
action?: "allow"
| "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
},
"name"
| "port"
| "action"
| "ruleType"
| "protocol"
| "targetIp",
>[];
}
SecurityGroupCreateRequest: { description?: string; name?: string } & { name: string } & {
rules: WithRequired<
{
action?: "allow"
| "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
},
"name"
| "port"
| "action"
| "ruleType"
| "protocol"
| "targetIp",
>[];
} & {
rules: WithRequired<
{
action?: "allow"
| "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
},
"name"
| "port"
| "action"
| "ruleType"
| "protocol"
| "targetIp",
>[];
}
SecurityGroupPatchRequest: { description?: string; name?: string }
Optionaldescription?: string
Optionalname?: string
SecurityGroupPutRequest: WithRequired<{ description?: string; name?: string }, "name" | "description">
SecurityGroupResponse: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
rules: {
action?: "allow" | "deny";
createdAt: string;
id: string;
name: string;
port?: number;
protocol: "tcp" | "udp" | "icmp" | "any";
ruleType: "inbound" | "outbound";
targetIp: string;
}[];
}
createdAt: string
Optionaldescription?: string
id: string
name: string
owner: { id: string; name: string }
rules: {
action?: "allow" | "deny";
createdAt: string;
id: string;
name: string;
port?: number;
protocol: "tcp" | "udp" | "icmp" | "any";
ruleType: "inbound" | "outbound";
targetIp: string;
}[]
SecurityGroupUpdatable: { description?: string; name?: string }
Optionaldescription?: string
Optionalname?: string
SecurityRuleBulkRequest: {
add?: WithRequired<
{
action?: "allow"
| "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
},
"name"
| "port"
| "action"
| "ruleType"
| "protocol"
| "targetIp",
>[];
patch?: {
data: {
action?: "allow" | "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
};
id: string;
}[];
remove?: string[];
}
Optionaladd?: WithRequired<
{
action?: "allow"
| "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
},
"name"
| "port"
| "action"
| "ruleType"
| "protocol"
| "targetIp",
>[]
Optionalpatch?: {
data: {
action?: "allow" | "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
};
id: string;
}[]
Optionalremove?: string[]
SecurityRuleCreateRequest: WithRequired<
{
action?: "allow"
| "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
},
"name"
| "port"
| "action"
| "ruleType"
| "protocol"
| "targetIp",
>
SecurityRulePatchRequest: {
action?: "allow" | "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
} & { id?: string }
SecurityRulePutRequest: WithRequired<
{
action?: "allow"
| "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
},
"name"
| "port"
| "action"
| "ruleType"
| "protocol"
| "targetIp",
>
SecurityRuleResponse: {
action?: "allow" | "deny";
createdAt: string;
id: string;
name: string;
port?: number;
protocol: "tcp" | "udp" | "icmp" | "any";
ruleType: "inbound" | "outbound";
targetIp: string;
}
Optionalaction?: "allow" | "deny"
createdAt: string
id: string
name: string
Optionalport?: number
protocol: "tcp" | "udp" | "icmp" | "any"
ruleType: "inbound" | "outbound"
targetIp: string
SecurityRuleUpdatable: {
action?: "allow" | "deny";
name?: string;
port?: number;
protocol?: "tcp" | "udp" | "icmp" | "any";
ruleType?: "inbound" | "outbound";
targetIp?: string;
}
Optionalaction?: "allow" | "deny"
Optionalname?: string
Optionalport?: number
Optionalprotocol?: "tcp" | "udp" | "icmp" | "any"
OptionalruleType?: "inbound" | "outbound"
OptionaltargetIp?: string
SnapshotCreateOnly: { targetVmId: string }
SnapshotCreateRequest: { description?: string; name?: string } & { name: string } & {
targetVmId: string;
}
SnapshotPatchRequest: { description?: string; name?: string }
Optionaldescription?: string
Optionalname?: string
SnapshotPutRequest: WithRequired<{ description?: string; name?: string }, "name" | "description">
SnapshotResponse: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
targetVirtualMachine: {
cpuCore: number;
cpuUtilization?: number;
createdAt: string;
id: string;
memorySize: number;
memoryUtilization?: number;
name: string;
networkInterfaces: {
id: string;
ipAddress: string;
macAddress: string;
name: string;
subnet: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
};
}[];
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active"
| "inactive";
storageUtilization?: number;
};
owner: { id: string; name: string };
securityGroups: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
rules: {
action?: "allow" | "deny";
createdAt: string;
id: string;
name: string;
port?: number;
protocol: "tcp" | "udp" | "icmp" | "any";
ruleType: "inbound" | "outbound";
targetIp: string;
}[];
}[];
status: "stopped"
| "running"
| "suspended";
storages: {
createdAt: string;
devicePath: string;
id: string;
name: string;
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
size: number;
}[];
storageUtilization?: number;
};
}
createdAt: string
Optionaldescription?: string
id: string
name: string
owner: { id: string; name: string }
targetVirtualMachine: {
cpuCore: number;
cpuUtilization?: number;
createdAt: string;
id: string;
memorySize: number;
memoryUtilization?: number;
name: string;
networkInterfaces: {
id: string;
ipAddress: string;
macAddress: string;
name: string;
subnet: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
};
}[];
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active"
| "inactive";
storageUtilization?: number;
};
owner: { id: string; name: string };
securityGroups: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
rules: {
action?: "allow" | "deny";
createdAt: string;
id: string;
name: string;
port?: number;
protocol: "tcp" | "udp" | "icmp" | "any";
ruleType: "inbound" | "outbound";
targetIp: string;
}[];
}[];
status: "stopped"
| "running"
| "suspended";
storages: {
createdAt: string;
devicePath: string;
id: string;
name: string;
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
size: number;
}[];
storageUtilization?: number;
}
cpuCore: number
OptionalcpuUtilization?: number
createdAt: string
id: string
memorySize: number
OptionalmemoryUtilization?: number
name: string
networkInterfaces: {
id: string;
ipAddress: string;
macAddress: string;
name: string;
subnet: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
};
}[]
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
}
OptionalcpuUtilization?: number
createdAt: string
id: string
ipAddress: string
isAdmin: boolean
OptionalmemoryUtilization?: number
name: string
status: "active" | "inactive"
OptionalstorageUtilization?: number
owner: { id: string; name: string }
securityGroups: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
rules: {
action?: "allow" | "deny";
createdAt: string;
id: string;
name: string;
port?: number;
protocol: "tcp" | "udp" | "icmp" | "any";
ruleType: "inbound" | "outbound";
targetIp: string;
}[];
}[]
status: "stopped" | "running" | "suspended"
storages: {
createdAt: string;
devicePath: string;
id: string;
name: string;
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
size: number;
}[]
OptionalstorageUtilization?: number
SnapshotUpdatable: { description?: string; name?: string }
Optionaldescription?: string
Optionalname?: string
StorageBulkRequest: {
add?: (
{ name?: string } & { name: string } & {
backupId?: string;
poolId: string;
size: number;
}
)[];
patch?: { data: { name?: string }; id: string }[];
remove?: string[];
}
Optionaladd?: (
{ name?: string } & { name: string } & {
backupId?: string;
poolId: string;
size: number;
}
)[]
Optionalpatch?: { data: { name?: string }; id: string }[]
Optionalremove?: string[]
StorageCreateOnly: { backupId?: string; poolId: string; size: number }
OptionalbackupId?: string
poolId: string
size: number
StorageCreateRequest: { name?: string } & { name: string } & {
backupId?: string;
poolId: string;
size: number;
}
StoragePatchRequest: { name?: string }
StoragePoolCreateOnly: { devicePath: string; nodeId: string }
devicePath: string
nodeId: string
StoragePoolCreateRequest: { devicePath: string; nodeId: string } & {
hasNetworkAccess?: boolean;
name?: string;
} & { hasNetworkAccess: boolean; name: string }
StoragePoolPatchRequest: { hasNetworkAccess?: boolean; name?: string }
OptionalhasNetworkAccess?: boolean
Optionalname?: string
StoragePoolPutRequest: WithRequired<
{ hasNetworkAccess?: boolean; name?: string },
"name" | "hasNetworkAccess",
>
StoragePoolResponse: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
}
availableSize: number
createdAt: string
hasNetworkAccess: boolean
id: string
name: string
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
}
OptionalcpuUtilization?: number
createdAt: string
id: string
ipAddress: string
isAdmin: boolean
OptionalmemoryUtilization?: number
name: string
status: "active" | "inactive"
OptionalstorageUtilization?: number
totalSize: number
usedSize: number
StoragePoolUpdatable: { hasNetworkAccess?: boolean; name?: string }
OptionalhasNetworkAccess?: boolean
Optionalname?: string
StoragePutRequest: WithRequired<{ name?: string }, "name">
StorageResponse: {
createdAt: string;
devicePath: string;
id: string;
name: string;
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
size: number;
}
createdAt: string
devicePath: string
id: string
name: string
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
}
availableSize: number
createdAt: string
hasNetworkAccess: boolean
id: string
name: string
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
}
OptionalcpuUtilization?: number
createdAt: string
id: string
ipAddress: string
isAdmin: boolean
OptionalmemoryUtilization?: number
name: string
status: "active" | "inactive"
OptionalstorageUtilization?: number
totalSize: number
usedSize: number
size: number
StorageUpdatable: { name?: string }
SubnetBulkRequest: {
add?: WithRequired<{ cidr?: string; name?: string }, "name" | "cidr">[];
patch?: { data: { cidr?: string; name?: string }; id: string }[];
remove?: string[];
}
Optionaladd?: WithRequired<{ cidr?: string; name?: string }, "name" | "cidr">[]
Optionalpatch?: { data: { cidr?: string; name?: string }; id: string }[]
Optionalremove?: string[]
SubnetCreateRequest: WithRequired<{ cidr?: string; name?: string }, "name" | "cidr">
SubnetPatchRequest: { cidr?: string; name?: string } & Record<string, never>
SubnetPutRequest: WithRequired<{ cidr?: string; name?: string }, "name" | "cidr">
SubnetResponse: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
}
cidr: string
createdAt: string
id: string
name: string
Optionalparent?: { cidr: string; createdAt: string; id: string; name: string }
cidr: string
createdAt: string
id: string
name: string
SubnetUpdatable: { cidr?: string; name?: string }
Optionalcidr?: string
Optionalname?: string
Summary: {
totalCpu: number;
totalMemory: number;
totalStorage: number;
usedCpu: number;
usedMemory: number;
usedStorage: number;
}
totalCpu: number
totalMemory: number
totalStorage: number
usedCpu: number
usedMemory: number
usedStorage: number
SummaryHistoryResponse: {
data: {
cpuHistory: { timestamp: number; value: number }[];
id: string;
memHistory: { timestamp: number; value: number }[];
name: string;
networkINHistory: { timestamp: number; value: number }[];
networkOUTHistory: { timestamp: number; value: number }[];
totalCpu: number;
totalMemory: number;
}[];
}
SummaryResponse: {
clusterSummary: {
totalCpu: number;
totalMemory: number;
totalStorage: number;
usedCpu: number;
usedMemory: number;
usedStorage: number;
};
}
clusterSummary: {
totalCpu: number;
totalMemory: number;
totalStorage: number;
usedCpu: number;
usedMemory: number;
usedStorage: number;
}
totalCpu: number
totalMemory: number
totalStorage: number
usedCpu: number
usedMemory: number
usedStorage: number
TotpInfo: { secret: string; uri: string }
secret: string
uri: string
UserCreateOnly: { password: string }
UserCreateRequest: { password: string } & {
email?: string;
isAdmin?: boolean;
isImageAdmin?: boolean;
isInstanceTypeAdmin?: boolean;
isNetworkAdmin?: boolean;
isNodeAdmin?: boolean;
isSecurityGroupAdmin?: boolean;
isVirtualMachineAdmin?: boolean;
maxCpuCore?: number;
maxMemorySize?: number;
maxStorageSize?: number;
name?: string;
} & {
email: string;
isAdmin: boolean;
maxCpuCore: number;
maxMemorySize: number;
maxStorageSize: number;
name: string;
}
UserPatchRequest: {
email?: string;
isAdmin?: boolean;
isImageAdmin?: boolean;
isInstanceTypeAdmin?: boolean;
isNetworkAdmin?: boolean;
isNodeAdmin?: boolean;
isSecurityGroupAdmin?: boolean;
isVirtualMachineAdmin?: boolean;
maxCpuCore?: number;
maxMemorySize?: number;
maxStorageSize?: number;
name?: string;
}
Optionalemail?: string
OptionalisAdmin?: boolean
OptionalisImageAdmin?: boolean
OptionalisInstanceTypeAdmin?: boolean
OptionalisNetworkAdmin?: boolean
OptionalisNodeAdmin?: boolean
OptionalisSecurityGroupAdmin?: boolean
OptionalisVirtualMachineAdmin?: boolean
OptionalmaxCpuCore?: number
OptionalmaxMemorySize?: number
OptionalmaxStorageSize?: number
Optionalname?: string
UserPutRequest: WithRequired<
{
email?: string;
isAdmin?: boolean;
isImageAdmin?: boolean;
isInstanceTypeAdmin?: boolean;
isNetworkAdmin?: boolean;
isNodeAdmin?: boolean;
isSecurityGroupAdmin?: boolean;
isVirtualMachineAdmin?: boolean;
maxCpuCore?: number;
maxMemorySize?: number;
maxStorageSize?: number;
name?: string;
},
| "name"
| "email"
| "isAdmin"
| "maxCpuCore"
| "maxMemorySize"
| "maxStorageSize"
| "isImageAdmin"
| "isInstanceTypeAdmin"
| "isVirtualMachineAdmin"
| "isNetworkAdmin"
| "isSecurityGroupAdmin"
| "isNodeAdmin",
>
UserResponse: {
createdAt: string;
email: string;
id: string;
isAdmin: boolean;
isImageAdmin: boolean;
isInstanceTypeAdmin: boolean;
isNetworkAdmin: boolean;
isNodeAdmin: boolean;
isSecurityGroupAdmin: boolean;
isVirtualMachineAdmin: boolean;
lastLoginAt: string;
maxCpuCore?: number;
maxMemorySize?: number;
maxStorageSize?: number;
name: string;
totpInfo?: { secret: string; uri: string };
}
createdAt: string
email: string
id: string
isAdmin: boolean
isImageAdmin: boolean
isInstanceTypeAdmin: boolean
isNetworkAdmin: boolean
isNodeAdmin: boolean
isSecurityGroupAdmin: boolean
isVirtualMachineAdmin: boolean
lastLoginAt: string
OptionalmaxCpuCore?: number
OptionalmaxMemorySize?: number
OptionalmaxStorageSize?: number
name: string
OptionaltotpInfo?: { secret: string; uri: string }
secret: string
uri: string
UserUpdatable: {
email?: string;
isAdmin?: boolean;
isImageAdmin?: boolean;
isInstanceTypeAdmin?: boolean;
isNetworkAdmin?: boolean;
isNodeAdmin?: boolean;
isSecurityGroupAdmin?: boolean;
isVirtualMachineAdmin?: boolean;
maxCpuCore?: number;
maxMemorySize?: number;
maxStorageSize?: number;
name?: string;
}
Optionalemail?: string
OptionalisAdmin?: boolean
OptionalisImageAdmin?: boolean
OptionalisInstanceTypeAdmin?: boolean
OptionalisNetworkAdmin?: boolean
OptionalisNodeAdmin?: boolean
OptionalisSecurityGroupAdmin?: boolean
OptionalisVirtualMachineAdmin?: boolean
OptionalmaxCpuCore?: number
OptionalmaxMemorySize?: number
OptionalmaxStorageSize?: number
Optionalname?: string
VirtualMachineCreateOnly: {
imageId: string;
middlewareId?: string;
nodeId: string;
publicKey: string;
securityGroupIds: string[];
storages: { backupId?: string; name: string; poolId: string; size: number }[];
subnetIds: string[];
}
imageId: string
OptionalmiddlewareId?: string
nodeId: string
publicKey: string
securityGroupIds: string[]
storages: { backupId?: string; name: string; poolId: string; size: number }[]
subnetIds: string[]
VirtualMachineCreateRequest: {
imageId: string;
middlewareId?: string;
nodeId: string;
publicKey: string;
securityGroupIds: string[];
storages: { backupId?: string; name: string; poolId: string; size: number }[];
subnetIds: string[];
} & {
name?: string;
spec?: { instanceTypeId: string }
| { cpu: number; memory: number };
} & {
name: string;
spec: { instanceTypeId: string }
| { cpu: number; memory: number };
}
VirtualMachinePatchRequest: {
name?: string;
spec?: { instanceTypeId: string } | { cpu: number; memory: number };
}
Optionalname?: string
Optionalspec?: { instanceTypeId: string } | { cpu: number; memory: number }
VirtualMachinePutRequest: WithRequired<
{
name?: string;
spec?: { instanceTypeId: string }
| { cpu: number; memory: number };
},
"name",
>
VirtualMachineResponse: {
cpuCore: number;
cpuUtilization?: number;
createdAt: string;
id: string;
memorySize: number;
memoryUtilization?: number;
name: string;
networkInterfaces: {
id: string;
ipAddress: string;
macAddress: string;
name: string;
subnet: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
};
}[];
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active"
| "inactive";
storageUtilization?: number;
};
owner: { id: string; name: string };
securityGroups: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
rules: {
action?: "allow" | "deny";
createdAt: string;
id: string;
name: string;
port?: number;
protocol: "tcp" | "udp" | "icmp" | "any";
ruleType: "inbound" | "outbound";
targetIp: string;
}[];
}[];
status: "stopped"
| "running"
| "suspended";
storages: {
createdAt: string;
devicePath: string;
id: string;
name: string;
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
size: number;
}[];
storageUtilization?: number;
}
cpuCore: number
OptionalcpuUtilization?: number
createdAt: string
id: string
memorySize: number
OptionalmemoryUtilization?: number
name: string
networkInterfaces: {
id: string;
ipAddress: string;
macAddress: string;
name: string;
subnet: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
};
}[]
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
}
OptionalcpuUtilization?: number
createdAt: string
id: string
ipAddress: string
isAdmin: boolean
OptionalmemoryUtilization?: number
name: string
status: "active" | "inactive"
OptionalstorageUtilization?: number
owner: { id: string; name: string }
securityGroups: {
createdAt: string;
description?: string;
id: string;
name: string;
owner: { id: string; name: string };
rules: {
action?: "allow" | "deny";
createdAt: string;
id: string;
name: string;
port?: number;
protocol: "tcp" | "udp" | "icmp" | "any";
ruleType: "inbound" | "outbound";
targetIp: string;
}[];
}[]
status: "stopped" | "running" | "suspended"
storages: {
createdAt: string;
devicePath: string;
id: string;
name: string;
pool: {
availableSize: number;
createdAt: string;
hasNetworkAccess: boolean;
id: string;
name: string;
node: {
cpuUtilization?: number;
createdAt: string;
id: string;
ipAddress: string;
isAdmin: boolean;
memoryUtilization?: number;
name: string;
status: "active" | "inactive";
storageUtilization?: number;
};
totalSize: number;
usedSize: number;
};
size: number;
}[]
OptionalstorageUtilization?: number
VirtualMachineUpdatable: {
name?: string;
spec?: { instanceTypeId: string } | { cpu: number; memory: number };
}
Optionalname?: string
Optionalspec?: { instanceTypeId: string } | { cpu: number; memory: number }
VirtualMachineWithCustomSpecUpdatable: { cpu: number; memory: number }
cpu: number
memory: number
VirtualMachineWithInstanceTypeUpdatable: { instanceTypeId: string }
VirtualNetworkCreateOnly: {
cidr: string;
initialSubnets: WithRequired<
{ cidr?: string; name?: string },
"name" | "cidr",
>[];
}
cidr: string
initialSubnets: WithRequired<{ cidr?: string; name?: string }, "name" | "cidr">[]
VirtualNetworkCreateRequest: { name?: string } & { name: string } & {
cidr: string;
initialSubnets: WithRequired<
{ cidr?: string; name?: string },
"name" | "cidr",
>[];
}
VirtualNetworkPatchRequest: { name?: string }
VirtualNetworkPutRequest: WithRequired<{ name?: string }, "name">
VirtualNetworkResponse: {
cidr: string;
createdAt: string;
id: string;
name: string;
owner: { id: string; name: string };
subnets: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
}[];
}
cidr: string
createdAt: string
id: string
name: string
owner: { id: string; name: string }
subnets: {
cidr: string;
createdAt: string;
id: string;
name: string;
parent?: { cidr: string; createdAt: string; id: string; name: string };
}[]
VirtualNetworkSummaryResponse: { cidr: string; createdAt: string; id: string; name: string }
cidr: string
createdAt: string
id: string
name: string
VirtualNetworkUpdatable: { name?: string }
Description
セキュリティグループバルク更新リクエストオブジェクト