timeweb_rs/models/vds.rs
1/*
2 * Документация публичного API
3 *
4 * # Введение 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.
5 *
6 * The version of the OpenAPI document: 1.0.0
7 * Contact: info@timeweb.cloud
8 * Generated by: https://openapi-generator.tech
9 */
10
11use serde::{Deserialize, Serialize};
12
13use crate::models;
14
15/// Vds : Сервер
16#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
17pub struct Vds {
18 /// ID для каждого экземпляра сервера. Автоматически генерируется при
19 /// создании.
20 #[serde(rename = "id")]
21 pub id: f64,
22 /// Удобочитаемое имя, установленное для сервера.
23 #[serde(rename = "name")]
24 pub name: String,
25 /// Комментарий к серверу.
26 #[serde(rename = "comment")]
27 pub comment: String,
28 /// Дата создания сервера в формате ISO8061.
29 #[serde(rename = "created_at")]
30 pub created_at: String,
31 #[serde(rename = "os")]
32 pub os: Box<models::VdsOs>,
33 #[serde(rename = "software", deserialize_with = "Option::deserialize")]
34 pub software: Option<Box<models::VdsSoftware>>,
35 /// ID тарифа сервера.
36 #[serde(rename = "preset_id", deserialize_with = "Option::deserialize")]
37 pub preset_id: Option<f64>,
38 /// Локация сервера.
39 #[serde(rename = "location")]
40 pub location: Location,
41 /// ID конфигуратора сервера.
42 #[serde(rename = "configurator_id", deserialize_with = "Option::deserialize")]
43 pub configurator_id: Option<f64>,
44 /// Режим загрузки ОС сервера.
45 #[serde(rename = "boot_mode")]
46 pub boot_mode: BootMode,
47 /// Статус сервера.
48 #[serde(rename = "status")]
49 pub status: Status,
50 /// Значение времени, указанное в комбинированном формате даты и времени
51 /// ISO8601, которое представляет, когда был запущен сервер.
52 #[serde(rename = "start_at", deserialize_with = "Option::deserialize")]
53 pub start_at: Option<chrono::DateTime<chrono::FixedOffset>>,
54 /// Это логическое значение, которое показывает, включена ли защита от DDoS
55 /// у данного сервера.
56 #[serde(rename = "is_ddos_guard")]
57 pub is_ddos_guard: bool,
58 /// Это логическое значение, которое показывает, доступно ли подключение по
59 /// SSH для поддержки.
60 #[serde(rename = "is_master_ssh")]
61 pub is_master_ssh: bool,
62 /// Это логическое значение, которое показывает, является ли CPU выделенным.
63 #[serde(rename = "is_dedicated_cpu")]
64 pub is_dedicated_cpu: bool,
65 /// Количество видеокарт сервера.
66 #[serde(rename = "gpu")]
67 pub gpu: f64,
68 /// Количество ядер процессора сервера.
69 #[serde(rename = "cpu")]
70 pub cpu: f64,
71 /// Частота ядер процессора сервера.
72 #[serde(rename = "cpu_frequency")]
73 pub cpu_frequency: String,
74 /// Размер (в Мб) ОЗУ сервера.
75 #[serde(rename = "ram")]
76 pub ram: f64,
77 /// Список дисков сервера.
78 #[serde(rename = "disks")]
79 pub disks: Vec<models::VdsDisksInner>,
80 /// ID аватара сервера.
81 #[serde(rename = "avatar_id", deserialize_with = "Option::deserialize")]
82 pub avatar_id: Option<String>,
83 /// Ссылка на аватар сервера.
84 #[serde(rename = "avatar_link", deserialize_with = "Option::deserialize")]
85 pub avatar_link: Option<String>,
86 /// Пароль от VNC.
87 #[serde(rename = "vnc_pass")]
88 pub vnc_pass: String,
89 /// Пароль root сервера или пароль Администратора для серверов Windows.
90 #[serde(rename = "root_pass", deserialize_with = "Option::deserialize")]
91 pub root_pass: Option<String>,
92 #[serde(rename = "image", deserialize_with = "Option::deserialize")]
93 pub image: Option<Box<models::VdsImage>>,
94 /// Список сетей сервера.
95 #[serde(rename = "networks")]
96 pub networks: Vec<models::VdsNetworksInner>,
97 /// Cloud-init скрипт.
98 #[serde(rename = "cloud_init", deserialize_with = "Option::deserialize")]
99 pub cloud_init: Option<String>,
100 /// Это логическое значение, которое показывает, включен ли QEMU-agent на
101 /// сервере.
102 #[serde(rename = "is_qemu_agent")]
103 pub is_qemu_agent: bool,
104 #[serde(rename = "availability_zone")]
105 pub availability_zone: models::AvailabilityZone
106}
107
108impl Vds {
109 /// Сервер
110 pub fn new(
111 id: f64,
112 name: String,
113 comment: String,
114 created_at: String,
115 os: models::VdsOs,
116 software: Option<models::VdsSoftware>,
117 preset_id: Option<f64>,
118 location: Location,
119 configurator_id: Option<f64>,
120 boot_mode: BootMode,
121 status: Status,
122 start_at: Option<chrono::DateTime<chrono::FixedOffset>>,
123 is_ddos_guard: bool,
124 is_master_ssh: bool,
125 is_dedicated_cpu: bool,
126 gpu: f64,
127 cpu: f64,
128 cpu_frequency: String,
129 ram: f64,
130 disks: Vec<models::VdsDisksInner>,
131 avatar_id: Option<String>,
132 avatar_link: Option<String>,
133 vnc_pass: String,
134 root_pass: Option<String>,
135 image: Option<models::VdsImage>,
136 networks: Vec<models::VdsNetworksInner>,
137 cloud_init: Option<String>,
138 is_qemu_agent: bool,
139 availability_zone: models::AvailabilityZone
140 ) -> Vds {
141 Vds {
142 id,
143 name,
144 comment,
145 created_at,
146 os: Box::new(os),
147 software: if let Some(x) = software {
148 Some(Box::new(x))
149 } else {
150 None
151 },
152 preset_id,
153 location,
154 configurator_id,
155 boot_mode,
156 status,
157 start_at,
158 is_ddos_guard,
159 is_master_ssh,
160 is_dedicated_cpu,
161 gpu,
162 cpu,
163 cpu_frequency,
164 ram,
165 disks,
166 avatar_id,
167 avatar_link,
168 vnc_pass,
169 root_pass,
170 image: if let Some(x) = image {
171 Some(Box::new(x))
172 } else {
173 None
174 },
175 networks,
176 cloud_init,
177 is_qemu_agent,
178 availability_zone
179 }
180 }
181}
182/// Локация сервера.
183#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
184pub enum Location {
185 #[serde(rename = "ru-1")]
186 Ru1,
187 #[serde(rename = "ru-2")]
188 Ru2,
189 #[serde(rename = "ru-3")]
190 Ru3,
191 #[serde(rename = "pl-1")]
192 Pl1,
193 #[serde(rename = "kz-1")]
194 Kz1,
195 #[serde(rename = "nl-1")]
196 Nl1
197}
198
199impl Default for Location {
200 fn default() -> Location {
201 Self::Ru1
202 }
203}
204/// Режим загрузки ОС сервера.
205#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
206pub enum BootMode {
207 #[serde(rename = "std")]
208 Std,
209 #[serde(rename = "single")]
210 Single,
211 #[serde(rename = "cd")]
212 Cd
213}
214
215impl Default for BootMode {
216 fn default() -> BootMode {
217 Self::Std
218 }
219}
220/// Статус сервера.
221#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
222pub enum Status {
223 #[serde(rename = "installing")]
224 Installing,
225 #[serde(rename = "software_install")]
226 SoftwareInstall,
227 #[serde(rename = "reinstalling")]
228 Reinstalling,
229 #[serde(rename = "on")]
230 On,
231 #[serde(rename = "off")]
232 Off,
233 #[serde(rename = "turning_on")]
234 TurningOn,
235 #[serde(rename = "turning_off")]
236 TurningOff,
237 #[serde(rename = "hard_turning_off")]
238 HardTurningOff,
239 #[serde(rename = "rebooting")]
240 Rebooting,
241 #[serde(rename = "hard_rebooting")]
242 HardRebooting,
243 #[serde(rename = "removing")]
244 Removing,
245 #[serde(rename = "removed")]
246 Removed,
247 #[serde(rename = "cloning")]
248 Cloning,
249 #[serde(rename = "transfer")]
250 Transfer,
251 #[serde(rename = "blocked")]
252 Blocked,
253 #[serde(rename = "configuring")]
254 Configuring,
255 #[serde(rename = "no_paid")]
256 NoPaid,
257 #[serde(rename = "permanent_blocked")]
258 PermanentBlocked
259}
260
261impl Default for Status {
262 fn default() -> Status {
263 Self::Installing
264 }
265}