nuxt-app
    Preparing search index...

    Interface components

    interface components {
        headers: never;
        parameters: never;
        pathItems: never;
        requestBodies: never;
        responses: never;
        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 };
        };
    }
    Index

    Properties

    headers: never
    parameters: never
    pathItems: never
    requestBodies: never
    responses: never
    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[]

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

    • BackupCreateOnly: { targetStorageId?: string; targetVirtualMachineId?: string }

      バックアップの作成時のみ設定可能なプロパティ

      • OptionaltargetStorageId?: string

        Format: uuid

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

      • OptionaltargetVirtualMachineId?: string

        Format: uuid

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

    • 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

        Format: date-time

        バックアップが作成された日時

      • Optionaldescription?: string

        バックアップの説明

      • id: string

        Format: uuid

        バックアップを識別するための一意なID

      • name: string

        バックアップの名前

      • owner: { id: string; name: string }

        バックアップの所有者情報

        • id: string

          Format: uuid

          ユーザを識別するための一意なID

        • name: string

          ユーザの名前

      • size: number

        Format: integer

        バックアップのサイズ(バイト単位)

      • 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

          Format: date-time

          ストレージ作成日時

        • devicePath: string

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

          /dev/vdb
          
        • id: string

          Format: uuid

          ストレージのID

        • 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

            ストレージプールの利用可能なサイズ(バイト単位)

            549755813888
            
          • createdAt: string

            Format: date-time

            ストレージプールが作成された日時

            2024-01-01T12:00:00Z
            
          • hasNetworkAccess: boolean

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

            true
            
          • id: string

            Format: uuid

            ストレージプールを識別するための一意なID

            550e8400-e29b-41d4-a716-446655440000
            
          • name: string

            ストレージプールの名前

            Node1 Pool 1
            
          • node: {
                cpuUtilization?: number;
                createdAt: string;
                id: string;
                ipAddress: string;
                isAdmin: boolean;
                memoryUtilization?: number;
                name: string;
                status: "active" | "inactive";
                storageUtilization?: number;
            }

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

            • OptionalcpuUtilization?: number

              Format: float

              CPU使用率(0.0から1.0の範囲)

              0.75
              
            • createdAt: string

              Format: date-time

              物理ノードが作成された日時

              2024-01-15T10:00:00Z
              
            • id: string

              Format: uuid

              物理ノードを識別するための一意なID

              194d84d4-8811-4ff1-bb68-0e0734990018
              
            • ipAddress: string

              Format: ipv4

              物理ノードのIPアドレス

              192.168.0.1
              
            • isAdmin: boolean

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

              true
              
            • OptionalmemoryUtilization?: number

              Format: float

              メモリ使用率(0.0から1.0の範囲)

              0.6
              
            • name: string

              物理ノードの名前

              node-01
              
            • status: "active" | "inactive"

              物理ノードの状態

              active
              @enum {string}
            • OptionalstorageUtilization?: number

              Format: float

              ストレージ使用率(0.0から1.0の範囲)

              0.8
              
          • totalSize: number

            ストレージプールの総サイズ(バイト単位)

            1099511627776
            
          • usedSize: number

            ストレージプールの使用済みサイズ(バイト単位)

            549755813888
            
        • 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

          仮想マシンに割り当てられたCPUコア数

        • OptionalcpuUtilization?: number

          Format: float

          CPU使用率(0.0から1.0の範囲)

          0.55
          
        • createdAt: string

          Format: date-time

          仮想マシンが作成された日時

        • id: string

          Format: uuid

          仮想マシンを識別するための一意なID

        • memorySize: number

          仮想マシンに割り当てられたメモリサイズ(バイト単位)

        • OptionalmemoryUtilization?: number

          Format: float

          メモリ使用率(0.0から1.0の範囲)

          0.7
          
        • 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

            Format: float

            CPU使用率(0.0から1.0の範囲)

            0.75
            
          • createdAt: string

            Format: date-time

            物理ノードが作成された日時

            2024-01-15T10:00:00Z
            
          • id: string

            Format: uuid

            物理ノードを識別するための一意なID

            194d84d4-8811-4ff1-bb68-0e0734990018
            
          • ipAddress: string

            Format: ipv4

            物理ノードのIPアドレス

            192.168.0.1
            
          • isAdmin: boolean

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

            true
            
          • OptionalmemoryUtilization?: number

            Format: float

            メモリ使用率(0.0から1.0の範囲)

            0.6
            
          • name: string

            物理ノードの名前

            node-01
            
          • status: "active" | "inactive"

            物理ノードの状態

            active
            @enum {string}
          • OptionalstorageUtilization?: number

            Format: float

            ストレージ使用率(0.0から1.0の範囲)

            0.8
            
        • owner: { id: string; name: string }

          仮想マシンの所有者情報

          • id: string

            Format: uuid

            ユーザを識別するための一意なID

          • 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

          Format: float

          ストレージ使用率(0.0から1.0の範囲)

          0.4
          
    • BackupUpdatable: { description?: string; name?: string }

      バックアップの更新可能なプロパティ

      • Optionaldescription?: string

        バックアップの説明

      • Optionalname?: string

        バックアップの名前

    • DeviceResponse: { deviceName: string; devicePath: string; size: number }

      ストレージデバイス情報のレスポンスプロパティ

      • deviceName: string

        ストレージデバイスの名前

        Hitachi SSD HUS724040ALA640
        
      • devicePath: string

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

        /dev/sdb
        
      • size: number

        ストレージデバイスのサイズ(バイト単位)

        4000787030016
        
    • ErrorResponse: {
          detail?: string;
          instance?: string;
          status?: number;
          title?: string;
          type?: string;
      }

      RFC 9457 (Problem Details for HTTP APIs) に準拠した標準のエラーレスポンス形式

      • Optionaldetail?: string

        エラーの詳細な説明

        The request parameters are invalid.
        
      • Optionalinstance?: string

        エラーが発生した特定のインスタンスを示すURI

        /requests/12345
        
      • Optionalstatus?: number

        HTTPステータスコード

        400
        
      • Optionaltitle?: string

        エラーの簡潔な説明

        Invalid Request
        
      • Optionaltype?: string

        エラーの種類を示す識別子

        https://api.kci.chiffon-lab.tech/errors/invalid-request
        
    • 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;
      }

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

      • cpuHistory: { timestamp: number; value: number }[]

        ノード/各VMのCPU使用数履歴(コア数単位)

      • id: string

        ノード/各VMのID

        node1/6001
        
      • memHistory: { timestamp: number; value: number }[]

        ノード/各VMのメモリ使用数履歴(バイト単位)

      • name: string

        ノード/各VMの名前

        node1/vm6001
        
      • networkINHistory: { timestamp: number; value: number }[]

        ノード/各VMのネットワーク入力履歴(バイト単位)

      • networkOUTHistory: { timestamp: number; value: number }[]

        ノード/各VMのネットワーク出力履歴(バイト単位)

      • totalCpu: number

        ノード/各VMのトータルCPU数(コア数単位)

        80
        
      • totalMemory: number

        ノード/各VMのメモリ総量(バイト単位)

        57899069440
        
    • HistoryItem: { timestamp: number; value: number }

      ノード/各VMのメトリクス履歴の1データポイント

      • timestamp: number

        ノード/各VMのメトリクスデータのタイムスタンプ(UNIXTIME)

        1722672000000
        
      • value: number

        ノード/各VMのメトリクスデータの値

        1.031
        
    • ImageClientUpdatable: { description?: string; name?: string }

      仮想マシンイメージのうち更新可能な情報を表すスキーマ

      • Optionaldescription?: string

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

        Ubuntu 22.04 LTS イメージ
        
      • Optionalname?: string

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

        Ubuntu 22.04 LTS
        
    • ImageCreateOnly: { storagePoolId?: string }

      イメージ作成時のみ設定可能なプロパティ

      • OptionalstoragePoolId?: string

        Format: uuid

        イメージを作成するストレージプールのID

    • ImageCreateRequest: { description?: string; name?: string } & { name: string } & {
          storagePoolId?: string;
      } & { storagePoolId: string }

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

    • ImagePatchRequest: { description?: string; name?: string }

      仮想マシンイメージ更新リクエスト(PATCH)オブジェクト

      • Optionaldescription?: string

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

        Ubuntu 22.04 LTS イメージ
        
      • Optionalname?: string

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

        Ubuntu 22.04 LTS
        
    • ImagePutRequest: { description?: string; name: string }

      仮想マシンイメージ更新リクエスト(PUT)オブジェクト

      • Optionaldescription?: string

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

        Ubuntu 22.04 LTS イメージ
        
      • name: string

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

        Ubuntu 22.04 LTS
        
    • 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

        Format: date-time

        仮想マシンイメージが作成された日時

      • Optionaldescription?: string

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

      • id: string

        Format: uuid

        仮想マシンイメージを識別するための一意なID

      • name: string

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

      • size: number

        Format: integer

        仮想マシンイメージのサイズ(バイト単位)

      • 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

          ストレージプールの利用可能なサイズ(バイト単位)

          549755813888
          
        • createdAt: string

          Format: date-time

          ストレージプールが作成された日時

          2024-01-01T12:00:00Z
          
        • hasNetworkAccess: boolean

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

          true
          
        • id: string

          Format: uuid

          ストレージプールを識別するための一意なID

          550e8400-e29b-41d4-a716-446655440000
          
        • name: string

          ストレージプールの名前

          Node1 Pool 1
          
        • node: {
              cpuUtilization?: number;
              createdAt: string;
              id: string;
              ipAddress: string;
              isAdmin: boolean;
              memoryUtilization?: number;
              name: string;
              status: "active" | "inactive";
              storageUtilization?: number;
          }

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

          • OptionalcpuUtilization?: number

            Format: float

            CPU使用率(0.0から1.0の範囲)

            0.75
            
          • createdAt: string

            Format: date-time

            物理ノードが作成された日時

            2024-01-15T10:00:00Z
            
          • id: string

            Format: uuid

            物理ノードを識別するための一意なID

            194d84d4-8811-4ff1-bb68-0e0734990018
            
          • ipAddress: string

            Format: ipv4

            物理ノードのIPアドレス

            192.168.0.1
            
          • isAdmin: boolean

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

            true
            
          • OptionalmemoryUtilization?: number

            Format: float

            メモリ使用率(0.0から1.0の範囲)

            0.6
            
          • name: string

            物理ノードの名前

            node-01
            
          • status: "active" | "inactive"

            物理ノードの状態

            active
            @enum {string}
          • OptionalstorageUtilization?: number

            Format: float

            ストレージ使用率(0.0から1.0の範囲)

            0.8
            
        • totalSize: number

          ストレージプールの総サイズ(バイト単位)

          1099511627776
          
        • usedSize: number

          ストレージプールの使用済みサイズ(バイト単位)

          549755813888
          
    • InstanceTypeCreateRequest: { cpuCore: number; memorySize: number; name: string }

      インスタンスタイプ作成リクエストオブジェクト

      • cpuCore: number

        Format: int64

        CPUコア数

        4
        
      • memorySize: number

        Format: int64

        メモリサイズ(バイト単位)

        8589934592
        
      • name: string

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

        micro
        
    • InstanceTypePatchRequest: { cpuCore?: number; memorySize?: number; name?: string }

      インスタンスタイプ更新リクエストオブジェクト(PATCH)

      • OptionalcpuCore?: number

        CPUコア数

        4
        
      • OptionalmemorySize?: number

        メモリサイズ(バイト単位)

        8589934592
        
      • Optionalname?: string

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

        micro
        
    • InstanceTypePutRequest: WithRequired<
          { cpuCore?: number; memorySize?: number; name?: string },
          "name" | "cpuCore" | "memorySize",
      >

      インスタンスタイプ更新リクエストオブジェクト(PUT)

    • InstanceTypeResponse: {
          cpuCore: number;
          createdAt: string;
          id: string;
          memorySize: number;
          name: string;
      }

      インスタンスタイプレスポンスオブジェクト

      • cpuCore: number

        CPUコア数

      • createdAt: string

        Format: date-time

        インスタンスタイプが作成された日時

      • id: string

        Format: uuid

        インスタンスタイプを識別するための一意なID

      • memorySize: number

        メモリサイズ(バイト単位)

      • name: string

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

    • InstanceTypeUpdatable: { cpuCore?: number; memorySize?: number; name?: string }

      インスタンスタイプのうち更新可能な情報を表すスキーマ

      • OptionalcpuCore?: number

        CPUコア数

        4
        
      • OptionalmemorySize?: number

        メモリサイズ(バイト単位)

        8589934592
        
      • Optionalname?: string

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

        micro
        
    • LoginRequest: { email: string; password: string }

      ログインリクエストオブジェクト

      • email: string

        Format: email

        ユーザのメールアドレス

      • password: string

        Format: password

        ユーザのパスワード

    • LoginResponse: { refreshToken: string; token: string }

      ログインレスポンスオブジェクト

      • refreshToken: string

        リフレッシュトークン

      • token: string

        アクセストークン

    • MiddlewareResponse: { id: string; name: string }

      ミドルウェアのレスポンスオブジェクト

      • id: string

        Format: uuid

        ミドルウェアを識別するための一意なID

      • name: string

        ミドルウェアの名前

    • NetworkInterfaceBulkRequest: unknown

      ネットワークインターフェースバルク更新リクエストオブジェクト

    • NetworkInterfaceCreateRequest: WithRequired<{ name?: string; subnetId?: string }, "name" | "subnetId">

      ネットワークインターフェース作成リクエストオブジェクト

    • NetworkInterfacePatchRequest: { name?: string; subnetId?: string }

      ネットワークインターフェース更新リクエストオブジェクト

      • Optionalname?: string

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

      • OptionalsubnetId?: string

        Format: uuid

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

    • 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

        Format: uuid

        ネットワークインターフェースを識別するための一意なID

      • ipAddress: string

        Format: ipv4

        ネットワークインターフェースのIPアドレス

        10.0.0.0/32
        
      • macAddress: string

        ネットワークインターフェースのMACアドレス

        02:42:ac:11:00:02
        
      • name: string

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

      • subnet: {
            cidr: string;
            createdAt: string;
            id: string;
            name: string;
            parent?: { cidr: string; createdAt: string; id: string; name: string };
        }
        • cidr: string

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

          10.0.0.0/24
          
        • createdAt: string

          Format: date-time

          サブネットが作成された日時

        • id: string

          Format: uuid

          サブネットを識別するための一意なID

        • name: string

          サブネットの名前

        • Optionalparent?: { cidr: string; createdAt: string; id: string; name: string }
          • cidr: string

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

            10.0.0.0/16
            
          • createdAt: string

            Format: date-time

            仮想ネットワークが作成された日時

          • id: string

            Format: uuid

            仮想ネットワークを識別するための一意なID

          • name: string

            仮想ネットワークの名前

    • NetworkInterfaceUpdatable: { name?: string; subnetId?: string }

      ネットワークインターフェース更新可能オブジェクト

      • Optionalname?: string

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

      • OptionalsubnetId?: string

        Format: uuid

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

    • NodeCandidateResponse: { ipAddress: string; name: string }

      物理ノード候補レスポンスオブジェクト

      • ipAddress: string

        Format: ipv4

        物理ノードのIPアドレス

        10.0.0.1
        
      • name: string

        物理ノードの名前

        node-01
        
    • NodeCreateOnly: { ipAddress: string; rootPassword: string }

      物理ノードを作成時に設定できるプロパティ

      • ipAddress: string

        Format: ipv4

        物理ノードのIPアドレス

        192.168.0.1
        
      • rootPassword: string

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

        strongpassword123
        
    • NodeCreateRequest: { ipAddress: string; rootPassword: string } & {
          isAdmin?: boolean;
          name?: string;
      }

      物理ノード追加リクエストオブジェクト

    • NodePatchRequest: { isAdmin?: boolean; name?: string }

      物理ノード更新リクエストオブジェクト(PATCH)

      • OptionalisAdmin?: boolean

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

        true
        
      • Optionalname?: string

        物理ノードの名前

        node-01
        
    • NodePutRequest: { isAdmin: boolean; name: string }

      物理ノード更新リクエストオブジェクト(PUT)

      • isAdmin: boolean

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

        true
        
      • name: string

        物理ノードの名前

        node-01
        
    • NodeResponse: {
          cpuUtilization?: number;
          createdAt: string;
          id: string;
          ipAddress: string;
          isAdmin: boolean;
          memoryUtilization?: number;
          name: string;
          status: "active" | "inactive";
          storageUtilization?: number;
      }

      物理ノードレスポンスオブジェクト

      • OptionalcpuUtilization?: number

        Format: float

        CPU使用率(0.0から1.0の範囲)

        0.75
        
      • createdAt: string

        Format: date-time

        物理ノードが作成された日時

        2024-01-15T10:00:00Z
        
      • id: string

        Format: uuid

        物理ノードを識別するための一意なID

        194d84d4-8811-4ff1-bb68-0e0734990018
        
      • ipAddress: string

        Format: ipv4

        物理ノードのIPアドレス

        192.168.0.1
        
      • isAdmin: boolean

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

        true
        
      • OptionalmemoryUtilization?: number

        Format: float

        メモリ使用率(0.0から1.0の範囲)

        0.6
        
      • name: string

        物理ノードの名前

        node-01
        
      • status: "active" | "inactive"

        物理ノードの状態

        active
        @enum {string}
      • OptionalstorageUtilization?: number

        Format: float

        ストレージ使用率(0.0から1.0の範囲)

        0.8
        
    • NodeUpdatable: { isAdmin?: boolean; name?: string }

      物理ノード更新可能なプロパティ

      • OptionalisAdmin?: boolean

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

        true
        
      • Optionalname?: string

        物理ノードの名前

        node-01
        
    • OwnerInfo: { id: string; name: string }

      所有者レスポンスオブジェクト

      • id: string

        Format: uuid

        ユーザを識別するための一意なID

      • name: string

        ユーザの名前

    • PasswordChangeRequest: { currentPassword: string; newPassword: string }

      パスワード変更リクエストオブジェクト

      • currentPassword: string

        現在のパスワード

      • newPassword: string

        新しいパスワード

    • RefreshRequest: { refreshToken: string }

      リフレッシュリクエストオブジェクト

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

      セキュリティグループ更新リクエストオブジェクト(PATCH)

      • Optionaldescription?: string

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

        Security group for web servers
        
      • Optionalname?: string

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

        web-servers
        
    • SecurityGroupPutRequest: WithRequired<{ description?: string; name?: string }, "name" | "description">

      セキュリティグループ更新リクエストオブジェクト(PUT)

    • 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

        Format: date-time

        セキュリティグループが作成された日時

      • Optionaldescription?: string

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

      • id: string

        Format: uuid

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

      • name: string

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

      • owner: { id: string; name: string }

        セキュリティグループの所有者情報

        • id: string

          Format: uuid

          ユーザを識別するための一意なID

        • 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

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

        Security group for web servers
        
      • Optionalname?: string

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

        web-servers
        
    • 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[]

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

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

      セキュリティルール更新リクエストオブジェクト(PATCH)

    • 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",
      >

      セキュリティルール更新リクエストオブジェクト(PUT)

    • 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

        Format: date-time

        セキュリティルールが作成された日時

      • id: string

        Format: uuid

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

      • name: string

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

      • Optionalport?: number

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

        22
        
      • protocol: "tcp" | "udp" | "icmp" | "any"

        適用されるプロトコル

      • ruleType: "inbound" | "outbound"

        ルールのタイプ(インバウンドまたはアウトバウンド)

      • targetIp: string

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

        192.0.2.0/24
        
    • 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

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

        22
        
      • Optionalprotocol?: "tcp" | "udp" | "icmp" | "any"

        適用されるプロトコル

      • OptionalruleType?: "inbound" | "outbound"

        ルールのタイプ(インバウンドまたはアウトバウンド)

      • OptionaltargetIp?: string

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

        192.0.2.0/24
        
    • SnapshotCreateOnly: { targetVmId: string }

      スナップショット作成時のみ設定可能なプロパティ

      • targetVmId: string

        Format: uuid

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

    • 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

        Format: date-time

        スナップショットが作成された日時

      • Optionaldescription?: string

        スナップショットの説明

      • id: string

        Format: uuid

        スナップショットを識別するための一意なID

      • name: string

        スナップショットの名前

      • owner: { id: string; name: string }

        スナップショットの所有者情報

        • id: string

          Format: uuid

          ユーザを識別するための一意なID

        • 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

          仮想マシンに割り当てられたCPUコア数

        • OptionalcpuUtilization?: number

          Format: float

          CPU使用率(0.0から1.0の範囲)

          0.55
          
        • createdAt: string

          Format: date-time

          仮想マシンが作成された日時

        • id: string

          Format: uuid

          仮想マシンを識別するための一意なID

        • memorySize: number

          仮想マシンに割り当てられたメモリサイズ(バイト単位)

        • OptionalmemoryUtilization?: number

          Format: float

          メモリ使用率(0.0から1.0の範囲)

          0.7
          
        • 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

            Format: float

            CPU使用率(0.0から1.0の範囲)

            0.75
            
          • createdAt: string

            Format: date-time

            物理ノードが作成された日時

            2024-01-15T10:00:00Z
            
          • id: string

            Format: uuid

            物理ノードを識別するための一意なID

            194d84d4-8811-4ff1-bb68-0e0734990018
            
          • ipAddress: string

            Format: ipv4

            物理ノードのIPアドレス

            192.168.0.1
            
          • isAdmin: boolean

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

            true
            
          • OptionalmemoryUtilization?: number

            Format: float

            メモリ使用率(0.0から1.0の範囲)

            0.6
            
          • name: string

            物理ノードの名前

            node-01
            
          • status: "active" | "inactive"

            物理ノードの状態

            active
            @enum {string}
          • OptionalstorageUtilization?: number

            Format: float

            ストレージ使用率(0.0から1.0の範囲)

            0.8
            
        • owner: { id: string; name: string }

          仮想マシンの所有者情報

          • id: string

            Format: uuid

            ユーザを識別するための一意なID

          • 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

          Format: float

          ストレージ使用率(0.0から1.0の範囲)

          0.4
          
    • 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[]

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

    • StorageCreateOnly: { backupId?: string; poolId: string; size: number }

      仮想マシンに新たなストレージをアタッチするとき設定可能なオブジェクト

      • OptionalbackupId?: string

        Format: uuid

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

      • poolId: string

        Format: uuid

        ストレージプールのID

      • size: number

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

    • StorageCreateRequest: { name?: string } & { name: string } & {
          backupId?: string;
          poolId: string;
          size: number;
      }

      仮想マシンに新たなストレージをアタッチするためのリクエストオブジェクト

    • StoragePatchRequest: { name?: string }

      仮想マシンにアタッチされたストレージの部分更新リクエストオブジェクト

      • Optionalname?: string

        ストレージの名前

    • StoragePoolCreateOnly: { devicePath: string; nodeId: string }

      ストレージプール作成時のみ設定可能なプロパティ

      • devicePath: string

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

        /dev/sdb
        
      • nodeId: string

        Format: uuid

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

        550e8400-e29b-41d4-a716-446655440000
        
    • StoragePoolCreateRequest: { devicePath: string; nodeId: string } & {
          hasNetworkAccess?: boolean;
          name?: string;
      } & { hasNetworkAccess: boolean; name: string }

      ストレージプール作成リクエストオブジェクト

    • StoragePoolPatchRequest: { hasNetworkAccess?: boolean; name?: string }

      ストレージプール更新リクエストオブジェクト(PATCH)

      • OptionalhasNetworkAccess?: boolean

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

        true
        
      • Optionalname?: string

        ストレージプールの名前

        Node1 Pool 1
        
    • StoragePoolPutRequest: WithRequired<
          { hasNetworkAccess?: boolean; name?: string },
          "name" | "hasNetworkAccess",
      >

      ストレージプール更新リクエストオブジェクト(PUT)

    • 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

        ストレージプールの利用可能なサイズ(バイト単位)

        549755813888
        
      • createdAt: string

        Format: date-time

        ストレージプールが作成された日時

        2024-01-01T12:00:00Z
        
      • hasNetworkAccess: boolean

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

        true
        
      • id: string

        Format: uuid

        ストレージプールを識別するための一意なID

        550e8400-e29b-41d4-a716-446655440000
        
      • name: string

        ストレージプールの名前

        Node1 Pool 1
        
      • node: {
            cpuUtilization?: number;
            createdAt: string;
            id: string;
            ipAddress: string;
            isAdmin: boolean;
            memoryUtilization?: number;
            name: string;
            status: "active" | "inactive";
            storageUtilization?: number;
        }

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

        • OptionalcpuUtilization?: number

          Format: float

          CPU使用率(0.0から1.0の範囲)

          0.75
          
        • createdAt: string

          Format: date-time

          物理ノードが作成された日時

          2024-01-15T10:00:00Z
          
        • id: string

          Format: uuid

          物理ノードを識別するための一意なID

          194d84d4-8811-4ff1-bb68-0e0734990018
          
        • ipAddress: string

          Format: ipv4

          物理ノードのIPアドレス

          192.168.0.1
          
        • isAdmin: boolean

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

          true
          
        • OptionalmemoryUtilization?: number

          Format: float

          メモリ使用率(0.0から1.0の範囲)

          0.6
          
        • name: string

          物理ノードの名前

          node-01
          
        • status: "active" | "inactive"

          物理ノードの状態

          active
          @enum {string}
        • OptionalstorageUtilization?: number

          Format: float

          ストレージ使用率(0.0から1.0の範囲)

          0.8
          
      • totalSize: number

        ストレージプールの総サイズ(バイト単位)

        1099511627776
        
      • usedSize: number

        ストレージプールの使用済みサイズ(バイト単位)

        549755813888
        
    • StoragePoolUpdatable: { hasNetworkAccess?: boolean; name?: string }

      ストレージプール更新可能なプロパティ

      • OptionalhasNetworkAccess?: boolean

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

        true
        
      • Optionalname?: string

        ストレージプールの名前

        Node1 Pool 1
        
    • 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

        Format: date-time

        ストレージ作成日時

      • devicePath: string

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

        /dev/vdb
        
      • id: string

        Format: uuid

        ストレージのID

      • 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

          ストレージプールの利用可能なサイズ(バイト単位)

          549755813888
          
        • createdAt: string

          Format: date-time

          ストレージプールが作成された日時

          2024-01-01T12:00:00Z
          
        • hasNetworkAccess: boolean

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

          true
          
        • id: string

          Format: uuid

          ストレージプールを識別するための一意なID

          550e8400-e29b-41d4-a716-446655440000
          
        • name: string

          ストレージプールの名前

          Node1 Pool 1
          
        • node: {
              cpuUtilization?: number;
              createdAt: string;
              id: string;
              ipAddress: string;
              isAdmin: boolean;
              memoryUtilization?: number;
              name: string;
              status: "active" | "inactive";
              storageUtilization?: number;
          }

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

          • OptionalcpuUtilization?: number

            Format: float

            CPU使用率(0.0から1.0の範囲)

            0.75
            
          • createdAt: string

            Format: date-time

            物理ノードが作成された日時

            2024-01-15T10:00:00Z
            
          • id: string

            Format: uuid

            物理ノードを識別するための一意なID

            194d84d4-8811-4ff1-bb68-0e0734990018
            
          • ipAddress: string

            Format: ipv4

            物理ノードのIPアドレス

            192.168.0.1
            
          • isAdmin: boolean

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

            true
            
          • OptionalmemoryUtilization?: number

            Format: float

            メモリ使用率(0.0から1.0の範囲)

            0.6
            
          • name: string

            物理ノードの名前

            node-01
            
          • status: "active" | "inactive"

            物理ノードの状態

            active
            @enum {string}
          • OptionalstorageUtilization?: number

            Format: float

            ストレージ使用率(0.0から1.0の範囲)

            0.8
            
        • totalSize: number

          ストレージプールの総サイズ(バイト単位)

          1099511627776
          
        • usedSize: number

          ストレージプールの使用済みサイズ(バイト単位)

          549755813888
          
      • size: number

        ストレージのサイズ(バイト単位)

    • StorageUpdatable: { name?: string }

      仮想マシンのストレージの更新可能プロパティを表すオブジェクト

      • Optionalname?: 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[]

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

    • 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

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

        10.0.0.0/24
        
      • createdAt: string

        Format: date-time

        サブネットが作成された日時

      • id: string

        Format: uuid

        サブネットを識別するための一意なID

      • name: string

        サブネットの名前

      • Optionalparent?: { cidr: string; createdAt: string; id: string; name: string }
        • cidr: string

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

          10.0.0.0/16
          
        • createdAt: string

          Format: date-time

          仮想ネットワークが作成された日時

        • id: string

          Format: uuid

          仮想ネットワークを識別するための一意なID

        • name: string

          仮想ネットワークの名前

    • SubnetUpdatable: { cidr?: string; name?: string }

      サブネットの更新可能なプロパティ

      • Optionalcidr?: string

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

        192.168.1.0/24
        
      • Optionalname?: string

        サブネットの名前

    • Summary: {
          totalCpu: number;
          totalMemory: number;
          totalStorage: number;
          usedCpu: number;
          usedMemory: number;
          usedStorage: number;
      }

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

      • totalCpu: number

        ノード/各VMのトータルCPU数(コア数単位)

        80
        
      • totalMemory: number

        ノード/各VMのメモリ総量(バイト単位)

        57899069440
        
      • totalStorage: number

        ノード/各VMのストレージ総量(バイト単位)

        21395853312
        
      • usedCpu: number

        ノード/各VMのCPU使用数(コア数単位)

        0.58
        
      • usedMemory: number

        ノード/各VMのメモリ使用量(バイト単位)

        16743878656
        
      • usedStorage: number

        ノード/各VMのストレージ使用量(バイト単位)

        13995106304
        
    • 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;
          }[];
      }

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

    • SummaryResponse: {
          clusterSummary: {
              totalCpu: number;
              totalMemory: number;
              totalStorage: number;
              usedCpu: number;
              usedMemory: number;
              usedStorage: number;
          };
      }

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

      • clusterSummary: {
            totalCpu: number;
            totalMemory: number;
            totalStorage: number;
            usedCpu: number;
            usedMemory: number;
            usedStorage: number;
        }
        • totalCpu: number

          ノード/各VMのトータルCPU数(コア数単位)

          80
          
        • totalMemory: number

          ノード/各VMのメモリ総量(バイト単位)

          57899069440
          
        • totalStorage: number

          ノード/各VMのストレージ総量(バイト単位)

          21395853312
          
        • usedCpu: number

          ノード/各VMのCPU使用数(コア数単位)

          0.58
          
        • usedMemory: number

          ノード/各VMのメモリ使用量(バイト単位)

          16743878656
          
        • usedStorage: number

          ノード/各VMのストレージ使用量(バイト単位)

          13995106304
          
    • TotpInfo: { secret: string; uri: string }

      TOTP情報オブジェクト

      • secret: string

        TOTPシークレットキー

      • uri: string

        TOTP URI(QRコード生成用)

    • UserCreateOnly: { password: string }

      ユーザ作成時のみに設定可能なプロパティ

      • password: string

        Format: password

        ユーザのパスワード

        StrongP@ssw0rd!
        
    • 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

        Format: email

        ユーザのメールアドレス

      • OptionalisAdmin?: boolean

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

      • OptionalisImageAdmin?: boolean

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

        false
        
      • OptionalisInstanceTypeAdmin?: boolean

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

        false
        
      • OptionalisNetworkAdmin?: boolean

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

        false
        
      • OptionalisNodeAdmin?: boolean

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

        false
        
      • OptionalisSecurityGroupAdmin?: boolean

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

        false
        
      • OptionalisVirtualMachineAdmin?: boolean

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

        false
        
      • OptionalmaxCpuCore?: number

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

        32
        
      • OptionalmaxMemorySize?: number

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

        17179869184
        
      • OptionalmaxStorageSize?: number

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

        1099511627776
        
      • 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

        Format: date-time

        ユーザが作成された日時

      • email: string

        Format: email

        ユーザのメールアドレス

      • id: string

        Format: uuid

        ユーザを識別するための一意なID

      • isAdmin: boolean

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

      • isImageAdmin: boolean

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

        false
        
      • isInstanceTypeAdmin: boolean

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

        false
        
      • isNetworkAdmin: boolean

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

        false
        
      • isNodeAdmin: boolean

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

        false
        
      • isSecurityGroupAdmin: boolean

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

        false
        
      • isVirtualMachineAdmin: boolean

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

        false
        
      • lastLoginAt: string

        Format: date-time

        ユーザが最後にログインした日時

      • OptionalmaxCpuCore?: number

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

        32
        
      • OptionalmaxMemorySize?: number

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

        17179869184
        
      • OptionalmaxStorageSize?: number

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

        1099511627776
        
      • name: string

        ユーザの名前

      • OptionaltotpInfo?: { secret: string; uri: string }
        • secret: string

          TOTPシークレットキー

        • uri: string

          TOTP URI(QRコード生成用)

    • 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

        Format: email

        ユーザのメールアドレス

      • OptionalisAdmin?: boolean

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

      • OptionalisImageAdmin?: boolean

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

        false
        
      • OptionalisInstanceTypeAdmin?: boolean

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

        false
        
      • OptionalisNetworkAdmin?: boolean

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

        false
        
      • OptionalisNodeAdmin?: boolean

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

        false
        
      • OptionalisSecurityGroupAdmin?: boolean

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

        false
        
      • OptionalisVirtualMachineAdmin?: boolean

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

        false
        
      • OptionalmaxCpuCore?: number

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

        32
        
      • OptionalmaxMemorySize?: number

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

        17179869184
        
      • OptionalmaxStorageSize?: number

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

        1099511627776
        
      • 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

        Format: uuid

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

      • OptionalmiddlewareId?: string

        Format: uuid

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

      • nodeId: string

        Format: uuid

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

      • publicKey: string

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

      • securityGroupIds: string[]

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

      • storages: { backupId?: string; name: string; poolId: string; size: number }[]

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

      • subnetIds: string[]

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

    • 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

        仮想マシンに割り当てられたCPUコア数

      • OptionalcpuUtilization?: number

        Format: float

        CPU使用率(0.0から1.0の範囲)

        0.55
        
      • createdAt: string

        Format: date-time

        仮想マシンが作成された日時

      • id: string

        Format: uuid

        仮想マシンを識別するための一意なID

      • memorySize: number

        仮想マシンに割り当てられたメモリサイズ(バイト単位)

      • OptionalmemoryUtilization?: number

        Format: float

        メモリ使用率(0.0から1.0の範囲)

        0.7
        
      • 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

          Format: float

          CPU使用率(0.0から1.0の範囲)

          0.75
          
        • createdAt: string

          Format: date-time

          物理ノードが作成された日時

          2024-01-15T10:00:00Z
          
        • id: string

          Format: uuid

          物理ノードを識別するための一意なID

          194d84d4-8811-4ff1-bb68-0e0734990018
          
        • ipAddress: string

          Format: ipv4

          物理ノードのIPアドレス

          192.168.0.1
          
        • isAdmin: boolean

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

          true
          
        • OptionalmemoryUtilization?: number

          Format: float

          メモリ使用率(0.0から1.0の範囲)

          0.6
          
        • name: string

          物理ノードの名前

          node-01
          
        • status: "active" | "inactive"

          物理ノードの状態

          active
          @enum {string}
        • OptionalstorageUtilization?: number

          Format: float

          ストレージ使用率(0.0から1.0の範囲)

          0.8
          
      • owner: { id: string; name: string }

        仮想マシンの所有者情報

        • id: string

          Format: uuid

          ユーザを識別するための一意なID

        • 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

        Format: float

        ストレージ使用率(0.0から1.0の範囲)

        0.4
        
    • 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、メモリ指定で作成する場合の更新可能なプロパティを持つオブジェクト

      • cpu: number

        仮想マシンのCPUコア数

      • memory: number

        仮想マシンのメモリ容量 (バイト単位)

    • VirtualMachineWithInstanceTypeUpdatable: { instanceTypeId: string }

      仮想マシンをインスタンスタイプ指定で作成する場合の更新可能なプロパティを持つオブジェクト

      • instanceTypeId: string

        Format: uuid

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

    • VirtualNetworkCreateOnly: {
          cidr: string;
          initialSubnets: WithRequired<
              { cidr?: string; name?: string },
              "name" | "cidr",
          >[];
      }

      仮想ネットワークの作成時のみに更新可能なフィールド

      • cidr: string

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

        10.0.0.0/16
        
      • 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 }

      仮想ネットワーク更新リクエストオブジェクト

      • Optionalname?: 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

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

        10.0.0.0/16
        
      • createdAt: string

        Format: date-time

        仮想ネットワークが作成された日時

      • id: string

        Format: uuid

        仮想ネットワークを識別するための一意なID

      • name: string

        仮想ネットワークの名前

      • owner: { id: string; name: string }

        仮想ネットワークの所有者情報

        • id: string

          Format: uuid

          ユーザを識別するための一意なID

        • 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

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

        10.0.0.0/16
        
      • createdAt: string

        Format: date-time

        仮想ネットワークが作成された日時

      • id: string

        Format: uuid

        仮想ネットワークを識別するための一意なID

      • name: string

        仮想ネットワークの名前

    • VirtualNetworkUpdatable: { name?: string }

      仮想ネットワークの更新可能なプロパティ

      • Optionalname?: string

        仮想ネットワークの名前