/** * Timeweb Cloud API * # Введение API Timeweb Cloud позволяет вам управлять ресурсами в облаке программным способом с использованием обычных HTTP-запросов. Множество функций, которые доступны в панели управления Timeweb Cloud, также доступны через API, что позволяет вам автоматизировать ваши собственные сценарии. В этой документации сперва будет описан общий дизайн и принципы работы API, а после этого конкретные конечные точки. Также будут приведены примеры запросов к ним. ## Запросы Запросы должны выполняться по протоколу `HTTPS`, чтобы гарантировать шифрование транзакций. Поддерживаются следующие методы запроса: |Метод|Применение| |--- |--- | |GET|Извлекает данные о коллекциях и отдельных ресурсах.| |POST|Для коллекций создает новый ресурс этого типа. Также используется для выполнения действий с конкретным ресурсом.| |PUT|Обновляет существующий ресурс.| |PATCH|Некоторые ресурсы поддерживают частичное обновление, то есть обновление только части атрибутов ресурса, в этом случае вместо метода PUT будет использован PATCH.| |DELETE|Удаляет ресурс.| Методы `POST`, `PUT` и `PATCH` могут включать объект в тело запроса с типом содержимого `application/json`. ### Параметры в запросах Некоторые коллекции поддерживают пагинацию, поиск или сортировку в запросах. В параметрах запроса требуется передать: - `limit` — обозначает количество записей, которое необходимо вернуть - `offset` — указывает на смещение, относительно начала списка - `search` — позволяет указать набор символов для поиска - `sort` — можно задать правило сортировки коллекции ## Ответы Запросы вернут один из следующих кодов состояния ответа HTTP: |Статус|Описание| |--- |--- | |200 OK|Действие с ресурсом было выполнено успешно.| |201 Created|Ресурс был успешно создан. При этом ресурс может быть как уже готовым к использованию, так и находиться в процессе запуска.| |204 No Content|Действие с ресурсом было выполнено успешно, и ответ не содержит дополнительной информации в теле.| |400 Bad Request|Был отправлен неверный запрос, например, в нем отсутствуют обязательные параметры и т. д. Тело ответа будет содержать дополнительную информацию об ошибке.| |401 Unauthorized|Ошибка аутентификации.| |403 Forbidden|Аутентификация прошла успешно, но недостаточно прав для выполнения действия.| |404 Not Found|Запрашиваемый ресурс не найден.| |409 Conflict|Запрос конфликтует с текущим состоянием.| |423 Locked|Ресурс из запроса заблокирован от применения к нему указанного метода.| |429 Too Many Requests|Был достигнут лимит по количеству запросов в единицу времени.| |500 Internal Server Error|При выполнении запроса произошла какая-то внутренняя ошибка. Чтобы решить эту проблему, лучше всего создать тикет в панели управления.| ### Структура успешного ответа Все конечные точки будут возвращать данные в формате `JSON`. Ответы на `GET`-запросы будут иметь на верхнем уровне следующую структуру атрибутов: |Название поля|Тип|Описание| |--- |--- |--- | |[entity_name]|object, object[], string[], number[], boolean|Динамическое поле, которое будет меняться в зависимости от запрашиваемого ресурса и будет содержать все атрибуты, необходимые для описания этого ресурса. Например, при запросе списка баз данных будет возвращаться поле `dbs`, а при запросе конкретного облачного сервера `server`. Для некоторых конечных точек в ответе может возвращаться сразу несколько ресурсов.| |meta|object|Опционально. Объект, который содержит вспомогательную информацию о ресурсе. Чаще всего будет встречаться при запросе коллекций и содержать поле `total`, которое будет указывать на количество элементов в коллекции.| |response_id|string|Опционально. В большинстве случаев в ответе будет содержаться ID ответа в формате UUIDv4, который однозначно указывает на ваш запрос внутри нашей системы. Если вам потребуется задать вопрос нашей поддержке, приложите к вопросу этот ID— так мы сможем найти ответ на него намного быстрее. Также вы можете использовать этот ID, чтобы убедиться, что это новый ответ на запрос и результат не был получен из кэша.| Пример запроса на получение списка SSH-ключей: ``` HTTP/2.0 200 OK { \"ssh_keys\":[ { \"body\":\"ssh-rsa AAAAB3NzaC1sdfghjkOAsBwWhs= example@device.local\", \"created_at\":\"2021-09-15T19:52:27Z\", \"expired_at\":null, \"id\":5297, \"is_default\":false, \"name\":\"example@device.local\", \"used_at\":null, \"used_by\":[] } ], \"meta\":{ \"total\":1 }, \"response_id\":\"94608d15-8672-4eed-8ab6-28bd6fa3cdf7\" } ``` ### Структура ответа с ошибкой |Название поля|Тип|Описание| |--- |--- |--- | |status_code|number|Короткий числовой идентификатор ошибки.| |error_code|string|Короткий текстовый идентификатор ошибки, который уточняет числовой идентификатор и удобен для программной обработки. Самый простой пример — это код `not_found` для ошибки 404.| |message|string, string[]|Опционально. В большинстве случаев в ответе будет содержаться человекочитаемое подробное описание ошибки или ошибок, которые помогут понять, что нужно исправить.| |response_id|string|Опционально. В большинстве случае в ответе будет содержаться ID ответа в формате UUIDv4, который однозначно указывает на ваш запрос внутри нашей системы. Если вам потребуется задать вопрос нашей поддержке, приложите к вопросу этот ID — так мы сможем найти ответ на него намного быстрее.| Пример: ``` HTTP/2.0 403 Forbidden { \"status_code\": 403, \"error_code\": \"forbidden\", \"message\": \"You do not have access for the attempted action\", \"response_id\": \"94608d15-8672-4eed-8ab6-28bd6fa3cdf7\" } ``` ## Статусы ресурсов Важно учесть, что при создании большинства ресурсов внутри платформы вам будет сразу возвращен ответ от сервера со статусом `200 OK` или `201 Created` и ID созданного ресурса в теле ответа, но при этом этот ресурс может быть ещё в *состоянии запуска*. Для того чтобы понять, в каком состоянии сейчас находится ваш ресурс, мы добавили поле `status` в ответ на получение информации о ресурсе. Список статусов будет отличаться в зависимости от типа ресурса. Увидеть поддерживаемый список статусов вы сможете в описании каждого конкретного ресурса. ## Ограничение скорости запросов (Rate Limiting) Чтобы обеспечить стабильность для всех пользователей, Timeweb Cloud защищает API от всплесков входящего трафика, анализируя количество запросов c каждого аккаунта к каждой конечной точке. Если ваше приложение отправляет более 20 запросов в секунду на одну конечную точку, то для этого запроса API может вернуть код состояния HTTP `429 Too Many Requests`. ## Аутентификация Доступ к API осуществляется с помощью JWT-токена. Токенами можно управлять внутри панели управления Timeweb Cloud в разделе *API и Terraform*. Токен необходимо передавать в заголовке каждого запроса в формате: ``` Authorization: Bearer $TIMEWEB_CLOUD_TOKEN ``` ## Формат примеров API Примеры в этой документации описаны с помощью `curl`, HTTP-клиента командной строки. На компьютерах `Linux` и `macOS` обычно по умолчанию установлен `curl`, и он доступен для загрузки на всех популярных платформах, включая `Windows`. Каждый пример разделен на несколько строк символом `\\`, который совместим с `bash`. Типичный пример выглядит так: ``` curl -X PATCH -H \"Content-Type: application/json\" -H \"Authorization: Bearer $TIMEWEB_CLOUD_TOKEN\" -d \'{\"name\":\"Cute Corvus\",\"comment\":\"Development Server\"}\' \"https://api.timeweb.cloud/api/v1/dedicated/1051\" ``` - Параметр `-X` задает метод запроса. Для согласованности метод будет указан во всех примерах, даже если он явно не требуется для методов `GET`. - Строки `-H` задают требуемые HTTP-заголовки. - Примеры, для которых требуется объект JSON в теле запроса, передают требуемые данные через параметр `-d`. Чтобы использовать приведенные примеры, не подставляя каждый раз в них свой токен, вы можете добавить токен один раз в переменные окружения в вашей консоли. Например, на `Linux` это можно сделать с помощью команды: ``` TIMEWEB_CLOUD_TOKEN=\"token\" ``` После этого токен будет автоматически подставляться в ваши запросы. Обратите внимание, что все значения в этой документации являются примерами. Не полагайтесь на IDы операционных систем, тарифов и т.д., используемые в примерах. Используйте соответствующую конечную точку для получения значений перед созданием ресурсов. ## Версионирование API построено согласно принципам [семантического версионирования](https://semver.org/lang/ru). Это значит, что мы гарантируем обратную совместимость всех изменений в пределах одной мажорной версии. Мажорная версия каждой конечной точки обозначается в пути запроса, например, запрос `/api/v1/servers` указывает, что этот метод имеет версию 1. * * The version of the OpenAPI document: 1.0.0 * Contact: info@timeweb.cloud * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { AddServerIP201Response, AddServerIPRequest, AutoBackup, CreateServer, CreateServer201Response, CreateServerDisk201Response, CreateServerDiskBackup201Response, CreateServerDiskBackupRequest, CreateServerDiskRequest, DeleteServerIPRequest, GetConfigurators200Response, GetOsList200Response, GetServerDiskAutoBackupSettings200Response, GetServerDiskBackup200Response, GetServerDiskBackups200Response, GetServerDisks200Response, GetServerIPs200Response, GetServerLogs200Response, GetServerStatistics200Response, GetServerStatisticsNew200Response, GetServers200Response, GetServersPresets200Response, GetSoftware200Response, PerformActionOnBackupRequest, PerformActionOnServerRequest, UpdateServer, UpdateServerDiskBackupRequest, UpdateServerDiskRequest, UpdateServerIPRequest, UpdateServerNATRequest, UpdateServerOSBootModeRequest } from '../models/index'; export interface AddServerIPOperationRequest { serverId: number; addServerIPRequest: AddServerIPRequest; } export interface CloneServerRequest { serverId: number; } export interface CreateServerRequest { createServer: CreateServer; } export interface CreateServerDiskOperationRequest { serverId: number; createServerDiskRequest?: CreateServerDiskRequest; } export interface CreateServerDiskBackupOperationRequest { serverId: number; diskId: number; createServerDiskBackupRequest?: CreateServerDiskBackupRequest; } export interface DeleteServerRequest { serverId: number; hash?: string; code?: string; } export interface DeleteServerDiskRequest { serverId: number; diskId: number; } export interface DeleteServerDiskBackupRequest { serverId: number; diskId: number; backupId: number; } export interface DeleteServerIPOperationRequest { serverId: number; deleteServerIPRequest: DeleteServerIPRequest; } export interface GetServerRequest { serverId: number; } export interface GetServerDiskRequest { serverId: number; diskId: number; } export interface GetServerDiskAutoBackupSettingsRequest { serverId: number; diskId: number; } export interface GetServerDiskBackupRequest { serverId: number; diskId: number; backupId: number; } export interface GetServerDiskBackupsRequest { serverId: number; diskId: number; } export interface GetServerDisksRequest { serverId: number; } export interface GetServerIPsRequest { serverId: number; } export interface GetServerLogsRequest { serverId: number; limit?: number; offset?: number; order?: GetServerLogsOrderEnum; } export interface GetServerStatisticsRequest { serverId: number; dateFrom: string; dateTo: string; } export interface GetServerStatisticsNewRequest { serverId: number; timeFrom: string; period: string; keys: GetServerStatisticsNewKeysEnum; } export interface GetServersRequest { limit?: number; offset?: number; } export interface HardShutdownServerRequest { serverId: number; } export interface ImageUnmountAndServerReloadRequest { serverId: number; } export interface PerformActionOnBackupOperationRequest { serverId: number; diskId: number; backupId: number; performActionOnBackupRequest?: PerformActionOnBackupRequest; } export interface PerformActionOnServerOperationRequest { serverId: number; performActionOnServerRequest?: PerformActionOnServerRequest; } export interface RebootServerRequest { serverId: number; } export interface ResetServerPasswordRequest { serverId: number; } export interface ShutdownServerRequest { serverId: number; } export interface StartServerRequest { serverId: number; } export interface UpdateServerRequest { serverId: number; updateServer: UpdateServer; } export interface UpdateServerDiskOperationRequest { serverId: number; diskId: number; updateServerDiskRequest?: UpdateServerDiskRequest; } export interface UpdateServerDiskAutoBackupSettingsRequest { serverId: number; diskId: number; autoBackup?: AutoBackup; } export interface UpdateServerDiskBackupOperationRequest { serverId: number; diskId: number; backupId: number; updateServerDiskBackupRequest?: UpdateServerDiskBackupRequest; } export interface UpdateServerIPOperationRequest { serverId: number; updateServerIPRequest: UpdateServerIPRequest; } export interface UpdateServerNATOperationRequest { serverId: number; updateServerNATRequest?: UpdateServerNATRequest; } export interface UpdateServerOSBootModeOperationRequest { serverId: number; updateServerOSBootModeRequest?: UpdateServerOSBootModeRequest; } /** * */ export declare class ServersApi extends runtime.BaseAPI { /** * Чтобы добавить IP-адрес сервера, отправьте POST-запрос на `/api/v1/servers/{server_id}/ips`. \\ На данный момент IPv6 доступны только для серверов с локацией `ru-1`. * Добавление IP-адреса сервера */ addServerIPRaw(requestParameters: AddServerIPOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы добавить IP-адрес сервера, отправьте POST-запрос на `/api/v1/servers/{server_id}/ips`. \\ На данный момент IPv6 доступны только для серверов с локацией `ru-1`. * Добавление IP-адреса сервера */ addServerIP(requestParameters: AddServerIPOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы клонировать сервер, отправьте POST-запрос на `/api/v1/servers/{server_id}/clone`. * Клонирование сервера */ cloneServerRaw(requestParameters: CloneServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы клонировать сервер, отправьте POST-запрос на `/api/v1/servers/{server_id}/clone`. * Клонирование сервера */ cloneServer(requestParameters: CloneServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы создать сервер, отправьте POST-запрос в `api/v1/servers`, задав необходимые атрибуты. Обязательно должен присутствовать один из параметров `configuration` или `preset_id`, а также `image_id` или `os_id`. Cервер будет создан с использованием предоставленной информации. Тело ответа будет содержать объект JSON с информацией о созданном сервере. * Создание сервера */ createServerRaw(requestParameters: CreateServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы создать сервер, отправьте POST-запрос в `api/v1/servers`, задав необходимые атрибуты. Обязательно должен присутствовать один из параметров `configuration` или `preset_id`, а также `image_id` или `os_id`. Cервер будет создан с использованием предоставленной информации. Тело ответа будет содержать объект JSON с информацией о созданном сервере. * Создание сервера */ createServer(requestParameters: CreateServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы создать диск сервера, отправьте POST-запрос на `/api/v1/servers/{server_id}/disks`. Системный диск создать нельзя. * Создание диска сервера */ createServerDiskRaw(requestParameters: CreateServerDiskOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы создать диск сервера, отправьте POST-запрос на `/api/v1/servers/{server_id}/disks`. Системный диск создать нельзя. * Создание диска сервера */ createServerDisk(requestParameters: CreateServerDiskOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы создать бэкап диска сервера, отправьте POST-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}/backups`. Тело ответа будет представлять собой объект JSON с ключом `backup`. * Создание бэкапа диска сервера */ createServerDiskBackupRaw(requestParameters: CreateServerDiskBackupOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы создать бэкап диска сервера, отправьте POST-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}/backups`. Тело ответа будет представлять собой объект JSON с ключом `backup`. * Создание бэкапа диска сервера */ createServerDiskBackup(requestParameters: CreateServerDiskBackupOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы удалить сервер, отправьте запрос DELETE в `/api/v1/servers/{server_id}`.\\ Обратите внимание, если на аккаунте включено удаление серверов по смс, то вернется ошибка 423. * Удаление сервера */ deleteServerRaw(requestParameters: DeleteServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы удалить сервер, отправьте запрос DELETE в `/api/v1/servers/{server_id}`.\\ Обратите внимание, если на аккаунте включено удаление серверов по смс, то вернется ошибка 423. * Удаление сервера */ deleteServer(requestParameters: DeleteServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы удалить диск сервера, отправьте DELETE-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}`. Нельзя удалять системный диск. * Удаление диска сервера */ deleteServerDiskRaw(requestParameters: DeleteServerDiskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы удалить диск сервера, отправьте DELETE-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}`. Нельзя удалять системный диск. * Удаление диска сервера */ deleteServerDisk(requestParameters: DeleteServerDiskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы удалить бэкап диска сервера, отправьте DELETE-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}/backups/{backup_id}`. * Удаление бэкапа диска сервера */ deleteServerDiskBackupRaw(requestParameters: DeleteServerDiskBackupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы удалить бэкап диска сервера, отправьте DELETE-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}/backups/{backup_id}`. * Удаление бэкапа диска сервера */ deleteServerDiskBackup(requestParameters: DeleteServerDiskBackupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы удалить IP-адрес сервера, отправьте DELETE-запрос на `/api/v1/servers/{server_id}/ips`. Нельзя удалить основной IP-адрес * Удаление IP-адреса сервера */ deleteServerIPRaw(requestParameters: DeleteServerIPOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы удалить IP-адрес сервера, отправьте DELETE-запрос на `/api/v1/servers/{server_id}/ips`. Нельзя удалить основной IP-адрес * Удаление IP-адреса сервера */ deleteServerIP(requestParameters: DeleteServerIPOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список всех конфигураторов серверов, отправьте GET-запрос на `/api/v1/configurator/servers`. Тело ответа будет представлять собой объект JSON с ключом `server_configurators`. * Получение списка конфигураторов серверов */ getConfiguratorsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список всех конфигураторов серверов, отправьте GET-запрос на `/api/v1/configurator/servers`. Тело ответа будет представлять собой объект JSON с ключом `server_configurators`. * Получение списка конфигураторов серверов */ getConfigurators(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список всех операционных систем, отправьте GET-запрос на `/api/v1/os/servers`. Тело ответа будет представлять собой объект JSON с ключом `servers_os`. * Получение списка операционных систем */ getOsListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список всех операционных систем, отправьте GET-запрос на `/api/v1/os/servers`. Тело ответа будет представлять собой объект JSON с ключом `servers_os`. * Получение списка операционных систем */ getOsList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить сервер, отправьте запрос GET в `/api/v1/servers/{server_id}`. * Получение сервера */ getServerRaw(requestParameters: GetServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить сервер, отправьте запрос GET в `/api/v1/servers/{server_id}`. * Получение сервера */ getServer(requestParameters: GetServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить диск сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}`. * Получение диска сервера */ getServerDiskRaw(requestParameters: GetServerDiskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить диск сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}`. * Получение диска сервера */ getServerDisk(requestParameters: GetServerDiskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы полученить настройки автобэкапов диска сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}/auto-backups`. * Получить настройки автобэкапов диска сервера */ getServerDiskAutoBackupSettingsRaw(requestParameters: GetServerDiskAutoBackupSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы полученить настройки автобэкапов диска сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}/auto-backups`. * Получить настройки автобэкапов диска сервера */ getServerDiskAutoBackupSettings(requestParameters: GetServerDiskAutoBackupSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить бэкап диска сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}/backups/{backup_id}`. Тело ответа будет представлять собой объект JSON с ключом `backup`. * Получение бэкапа диска сервера */ getServerDiskBackupRaw(requestParameters: GetServerDiskBackupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить бэкап диска сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}/backups/{backup_id}`. Тело ответа будет представлять собой объект JSON с ключом `backup`. * Получение бэкапа диска сервера */ getServerDiskBackup(requestParameters: GetServerDiskBackupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список бэкапов диска сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}/backups`. Тело ответа будет представлять собой объект JSON с ключом `backups`. * Получение списка бэкапов диска сервера */ getServerDiskBackupsRaw(requestParameters: GetServerDiskBackupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список бэкапов диска сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}/backups`. Тело ответа будет представлять собой объект JSON с ключом `backups`. * Получение списка бэкапов диска сервера */ getServerDiskBackups(requestParameters: GetServerDiskBackupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список дисков сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/disks`. * Получение списка дисков сервера */ getServerDisksRaw(requestParameters: GetServerDisksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список дисков сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/disks`. * Получение списка дисков сервера */ getServerDisks(requestParameters: GetServerDisksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список IP-адресов сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/ips`. \\ На данный момент IPv6 доступны только для локации `ru-1`. * Получение списка IP-адресов сервера */ getServerIPsRaw(requestParameters: GetServerIPsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список IP-адресов сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/ips`. \\ На данный момент IPv6 доступны только для локации `ru-1`. * Получение списка IP-адресов сервера */ getServerIPs(requestParameters: GetServerIPsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список логов сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/logs`. * Получение списка логов сервера */ getServerLogsRaw(requestParameters: GetServerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список логов сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/logs`. * Получение списка логов сервера */ getServerLogs(requestParameters: GetServerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить статистику сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/statistics`. * Получение статистики сервера */ getServerStatisticsRaw(requestParameters: GetServerStatisticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить статистику сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/statistics`. * Получение статистики сервера */ getServerStatistics(requestParameters: GetServerStatisticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить статистику сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/statistics/{time_from}/{period}/{keys}`. * Получение статистики сервера */ getServerStatisticsNewRaw(requestParameters: GetServerStatisticsNewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить статистику сервера, отправьте GET-запрос на `/api/v1/servers/{server_id}/statistics/{time_from}/{period}/{keys}`. * Получение статистики сервера */ getServerStatisticsNew(requestParameters: GetServerStatisticsNewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список серверов, отправьте GET-запрос на `/api/v1/servers`. Тело ответа будет представлять собой объект JSON с ключом `servers`. * Получение списка серверов */ getServersRaw(requestParameters: GetServersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список серверов, отправьте GET-запрос на `/api/v1/servers`. Тело ответа будет представлять собой объект JSON с ключом `servers`. * Получение списка серверов */ getServers(requestParameters?: GetServersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список всех тарифов серверов, отправьте GET-запрос на `/api/v1/presets/servers`. Тело ответа будет представлять собой объект JSON с ключом `server_presets`. * Получение списка тарифов серверов */ getServersPresetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список всех тарифов серверов, отправьте GET-запрос на `/api/v1/presets/servers`. Тело ответа будет представлять собой объект JSON с ключом `server_presets`. * Получение списка тарифов серверов */ getServersPresets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список ПО из маркетплейса, отправьте GET-запрос на `/api/v1/software/servers`. Тело ответа будет представлять собой объект JSON с ключом `servers_software`. * Получение списка ПО из маркетплейса */ getSoftwareRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список ПО из маркетплейса, отправьте GET-запрос на `/api/v1/software/servers`. Тело ответа будет представлять собой объект JSON с ключом `servers_software`. * Получение списка ПО из маркетплейса */ getSoftware(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы выполнить принудительное выключение сервера, отправьте POST-запрос на `/api/v1/servers/{server_id}/hard-shutdown`. * Принудительное выключение сервера */ hardShutdownServerRaw(requestParameters: HardShutdownServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы выполнить принудительное выключение сервера, отправьте POST-запрос на `/api/v1/servers/{server_id}/hard-shutdown`. * Принудительное выключение сервера */ hardShutdownServer(requestParameters: HardShutdownServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы отмонтировать ISO образ и перезагрузить сервер, отправьте POST-запрос на `/api/v1/servers/{server_id}/image-unmount`. * Отмонтирование ISO образа и перезагрузка сервера */ imageUnmountAndServerReloadRaw(requestParameters: ImageUnmountAndServerReloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы отмонтировать ISO образ и перезагрузить сервер, отправьте POST-запрос на `/api/v1/servers/{server_id}/image-unmount`. * Отмонтирование ISO образа и перезагрузка сервера */ imageUnmountAndServerReload(requestParameters: ImageUnmountAndServerReloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы выполнить действие над бэкапом диска сервера, отправьте POST-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}/backups/{backup_id}/action`. * Выполнение действия над бэкапом диска сервера */ performActionOnBackupRaw(requestParameters: PerformActionOnBackupOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы выполнить действие над бэкапом диска сервера, отправьте POST-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}/backups/{backup_id}/action`. * Выполнение действия над бэкапом диска сервера */ performActionOnBackup(requestParameters: PerformActionOnBackupOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы выполнить действие над сервером, отправьте POST-запрос на `/api/v1/servers/{server_id}/action`. * Выполнение действия над сервером */ performActionOnServerRaw(requestParameters: PerformActionOnServerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы выполнить действие над сервером, отправьте POST-запрос на `/api/v1/servers/{server_id}/action`. * Выполнение действия над сервером */ performActionOnServer(requestParameters: PerformActionOnServerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы перезагрузить сервер, отправьте POST-запрос на `/api/v1/servers/{server_id}/reboot`. * Перезагрузка сервера */ rebootServerRaw(requestParameters: RebootServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы перезагрузить сервер, отправьте POST-запрос на `/api/v1/servers/{server_id}/reboot`. * Перезагрузка сервера */ rebootServer(requestParameters: RebootServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы сбросить пароль сервера, отправьте POST-запрос на `/api/v1/servers/{server_id}/reset-password`. * Сброс пароля сервера */ resetServerPasswordRaw(requestParameters: ResetServerPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы сбросить пароль сервера, отправьте POST-запрос на `/api/v1/servers/{server_id}/reset-password`. * Сброс пароля сервера */ resetServerPassword(requestParameters: ResetServerPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы выключить сервер, отправьте POST-запрос на `/api/v1/servers/{server_id}/shutdown`. * Выключение сервера */ shutdownServerRaw(requestParameters: ShutdownServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы выключить сервер, отправьте POST-запрос на `/api/v1/servers/{server_id}/shutdown`. * Выключение сервера */ shutdownServer(requestParameters: ShutdownServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы запустить сервер, отправьте POST-запрос на `/api/v1/servers/{server_id}/start`. * Запуск сервера */ startServerRaw(requestParameters: StartServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы запустить сервер, отправьте POST-запрос на `/api/v1/servers/{server_id}/start`. * Запуск сервера */ startServer(requestParameters: StartServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы обновить только определенные атрибуты сервера, отправьте запрос PATCH в `/api/v1/servers/{server_id}`. * Изменение сервера */ updateServerRaw(requestParameters: UpdateServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы обновить только определенные атрибуты сервера, отправьте запрос PATCH в `/api/v1/servers/{server_id}`. * Изменение сервера */ updateServer(requestParameters: UpdateServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы изменить параметры диска сервера, отправьте PATCH-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}`. * Изменение параметров диска сервера */ updateServerDiskRaw(requestParameters: UpdateServerDiskOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы изменить параметры диска сервера, отправьте PATCH-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}`. * Изменение параметров диска сервера */ updateServerDisk(requestParameters: UpdateServerDiskOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы изменить настройки автобэкапов диска сервера, отправьте PATCH-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}/auto-backups`. * Изменение настроек автобэкапов диска сервера */ updateServerDiskAutoBackupSettingsRaw(requestParameters: UpdateServerDiskAutoBackupSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы изменить настройки автобэкапов диска сервера, отправьте PATCH-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}/auto-backups`. * Изменение настроек автобэкапов диска сервера */ updateServerDiskAutoBackupSettings(requestParameters: UpdateServerDiskAutoBackupSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы изменить бэкап диска сервера, отправьте PATCH-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}/backups/{backup_id}`. * Изменение бэкапа диска сервера */ updateServerDiskBackupRaw(requestParameters: UpdateServerDiskBackupOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы изменить бэкап диска сервера, отправьте PATCH-запрос на `/api/v1/servers/{server_id}/disks/{disk_id}/backups/{backup_id}`. * Изменение бэкапа диска сервера */ updateServerDiskBackup(requestParameters: UpdateServerDiskBackupOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы изменить IP-адрес сервера, отправьте POST-запрос на `/api/v1/servers/{server_id}/ips`. * Изменение IP-адреса сервера */ updateServerIPRaw(requestParameters: UpdateServerIPOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы изменить IP-адрес сервера, отправьте POST-запрос на `/api/v1/servers/{server_id}/ips`. * Изменение IP-адреса сервера */ updateServerIP(requestParameters: UpdateServerIPOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы измененить правила маршрутизации трафика сервера (NAT), отправьте PATCH-запрос на `/api/v1/servers/{server_id}/local-networks/nat-mode`. * Изменение правил маршрутизации трафика сервера (NAT) */ updateServerNATRaw(requestParameters: UpdateServerNATOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы измененить правила маршрутизации трафика сервера (NAT), отправьте PATCH-запрос на `/api/v1/servers/{server_id}/local-networks/nat-mode`. * Изменение правил маршрутизации трафика сервера (NAT) */ updateServerNAT(requestParameters: UpdateServerNATOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы изменить тип загрузки операционной системы сервера, отправьте POST-запрос на `/api/v1/servers/{server_id}/boot-mode`. \\ После смены типа загрузки сервер будет перезапущен. * Выбор типа загрузки операционной системы сервера */ updateServerOSBootModeRaw(requestParameters: UpdateServerOSBootModeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы изменить тип загрузки операционной системы сервера, отправьте POST-запрос на `/api/v1/servers/{server_id}/boot-mode`. \\ После смены типа загрузки сервер будет перезапущен. * Выбор типа загрузки операционной системы сервера */ updateServerOSBootMode(requestParameters: UpdateServerOSBootModeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const GetServerLogsOrderEnum: { readonly Asc: "asc"; readonly Desc: "desc"; }; export type GetServerLogsOrderEnum = typeof GetServerLogsOrderEnum[keyof typeof GetServerLogsOrderEnum]; /** * @export */ export declare const GetServerStatisticsNewKeysEnum: { readonly SystemCpuUtil: "system.cpu.util"; readonly NetworkRequest: "network.request"; readonly NetworkResponse: "network.response"; }; export type GetServerStatisticsNewKeysEnum = typeof GetServerStatisticsNewKeysEnum[keyof typeof GetServerStatisticsNewKeysEnum];