timeweb_rs/models/dedicated_server.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/// DedicatedServer : Выделенный сервер
16#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
17pub struct DedicatedServer {
18 /// ID для каждого экземпляра выделенного сервера. Автоматически
19 /// генерируется при создании.
20 #[serde(rename = "id")]
21 pub id: f64,
22 /// Описание параметров процессора выделенного сервера.
23 #[serde(rename = "cpu_description")]
24 pub cpu_description: String,
25 /// Описание параметров жёсткого диска выделенного сервера.
26 #[serde(rename = "hdd_description")]
27 pub hdd_description: String,
28 /// Описание ОЗУ выделенного сервера.
29 #[serde(rename = "ram_description")]
30 pub ram_description: String,
31 /// Значение времени, указанное в комбинированном формате даты и времени
32 /// ISO8601, которое представляет, когда был создан выделенный сервер.
33 #[serde(rename = "created_at")]
34 pub created_at: chrono::DateTime<chrono::FixedOffset>,
35 /// IP-адрес сетевого интерфейса IPv4.
36 #[serde(rename = "ip", deserialize_with = "Option::deserialize")]
37 pub ip: Option<String>,
38 /// IP-адрес сетевого интерфейса IPMI.
39 #[serde(rename = "ipmi_ip", deserialize_with = "Option::deserialize")]
40 pub ipmi_ip: Option<String>,
41 /// Логин, используемый для входа в IPMI-консоль.
42 #[serde(rename = "ipmi_login", deserialize_with = "Option::deserialize")]
43 pub ipmi_login: Option<String>,
44 /// Пароль, используемый для входа в IPMI-консоль.
45 #[serde(rename = "ipmi_password", deserialize_with = "Option::deserialize")]
46 pub ipmi_password: Option<String>,
47 /// IP-адрес сетевого интерфейса IPv6.
48 #[serde(rename = "ipv6", deserialize_with = "Option::deserialize")]
49 pub ipv6: Option<String>,
50 /// Внутренний дополнительный ID сервера.
51 #[serde(rename = "node_id", deserialize_with = "Option::deserialize")]
52 pub node_id: Option<f64>,
53 /// Удобочитаемое имя, установленное для выделенного сервера.
54 #[serde(rename = "name")]
55 pub name: String,
56 /// Комментарий к выделенному серверу.
57 #[serde(rename = "comment")]
58 pub comment: String,
59 /// Пароль для подключения к VNC-консоли выделенного сервера.
60 #[serde(rename = "vnc_pass", deserialize_with = "Option::deserialize")]
61 pub vnc_pass: Option<String>,
62 /// Строка состояния, указывающая состояние выделенного сервера. Может быть
63 /// «installing», «installed», «on» или «off».
64 #[serde(rename = "status")]
65 pub status: Status,
66 /// ID операционной системы, установленной на выделенный сервер.
67 #[serde(rename = "os_id", deserialize_with = "Option::deserialize")]
68 pub os_id: Option<f64>,
69 /// ID панели управления, установленной на выделенный сервер.
70 #[serde(rename = "cp_id", deserialize_with = "Option::deserialize")]
71 pub cp_id: Option<f64>,
72 /// ID интернет-канала, установленного на выделенный сервер.
73 #[serde(rename = "bandwidth_id", deserialize_with = "Option::deserialize")]
74 pub bandwidth_id: Option<f64>,
75 /// Массив уникальных ID сетевых дисков, подключенных к выделенному серверу.
76 #[serde(rename = "network_drive_id", deserialize_with = "Option::deserialize")]
77 pub network_drive_id: Option<Vec<f64>>,
78 /// Массив уникальных ID дополнительных IP-адресов, подключенных к
79 /// выделенному серверу.
80 #[serde(
81 rename = "additional_ip_addr_id",
82 deserialize_with = "Option::deserialize"
83 )]
84 pub additional_ip_addr_id: Option<Vec<f64>>,
85 /// ID списка дополнительных услуг выделенного сервера.
86 #[serde(rename = "plan_id", deserialize_with = "Option::deserialize")]
87 pub plan_id: Option<f64>,
88 /// Стоимость выделенного сервера.
89 #[serde(rename = "price")]
90 pub price: f64,
91 /// Локация сервера.
92 #[serde(rename = "location")]
93 pub location: Location,
94 /// Количество готовых к автоматической выдаче серверов. Если значение равно
95 /// 0, сервер будет установлен через инженеров.
96 #[serde(rename = "autoinstall_ready")]
97 pub autoinstall_ready: f64,
98 /// Пароль root сервера или пароль Администратора для серверов Windows.
99 #[serde(rename = "password", deserialize_with = "Option::deserialize")]
100 pub password: Option<String>,
101 /// Ссылка на аватар сервера.
102 #[serde(rename = "avatar_link", deserialize_with = "Option::deserialize")]
103 pub avatar_link: Option<String>,
104 /// Это логическое значение, которое показывает, готов ли выделенный сервер
105 /// к моментальной выдаче.
106 #[serde(rename = "is_pre_installed")]
107 pub is_pre_installed: bool,
108 /// ID тарифа сервера.
109 #[serde(rename = "preset_id")]
110 pub preset_id: i32,
111 /// ID проекта
112 #[serde(rename = "project_id")]
113 pub project_id: i32
114}
115
116impl DedicatedServer {
117 /// Выделенный сервер
118 pub fn new(
119 id: f64,
120 cpu_description: String,
121 hdd_description: String,
122 ram_description: String,
123 created_at: chrono::DateTime<chrono::FixedOffset>,
124 ip: Option<String>,
125 ipmi_ip: Option<String>,
126 ipmi_login: Option<String>,
127 ipmi_password: Option<String>,
128 ipv6: Option<String>,
129 node_id: Option<f64>,
130 name: String,
131 comment: String,
132 vnc_pass: Option<String>,
133 status: Status,
134 os_id: Option<f64>,
135 cp_id: Option<f64>,
136 bandwidth_id: Option<f64>,
137 network_drive_id: Option<Vec<f64>>,
138 additional_ip_addr_id: Option<Vec<f64>>,
139 plan_id: Option<f64>,
140 price: f64,
141 location: Location,
142 autoinstall_ready: f64,
143 password: Option<String>,
144 avatar_link: Option<String>,
145 is_pre_installed: bool,
146 preset_id: i32,
147 project_id: i32
148 ) -> DedicatedServer {
149 DedicatedServer {
150 id,
151 cpu_description,
152 hdd_description,
153 ram_description,
154 created_at,
155 ip,
156 ipmi_ip,
157 ipmi_login,
158 ipmi_password,
159 ipv6,
160 node_id,
161 name,
162 comment,
163 vnc_pass,
164 status,
165 os_id,
166 cp_id,
167 bandwidth_id,
168 network_drive_id,
169 additional_ip_addr_id,
170 plan_id,
171 price,
172 location,
173 autoinstall_ready,
174 password,
175 avatar_link,
176 is_pre_installed,
177 preset_id,
178 project_id
179 }
180 }
181}
182/// Строка состояния, указывающая состояние выделенного сервера. Может быть
183/// «installing», «installed», «on» или «off».
184#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
185pub enum Status {
186 #[serde(rename = "installing")]
187 Installing,
188 #[serde(rename = "installed")]
189 Installed,
190 #[serde(rename = "on")]
191 On,
192 #[serde(rename = "off")]
193 Off
194}
195
196impl Default for Status {
197 fn default() -> Status {
198 Self::Installing
199 }
200}
201/// Локация сервера.
202#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
203pub enum Location {
204 #[serde(rename = "ru-1")]
205 Ru1,
206 #[serde(rename = "pl-1")]
207 Pl1,
208 #[serde(rename = "kz-1")]
209 Kz1,
210 #[serde(rename = "nl-1")]
211 Nl1,
212 #[serde(rename = "tr-1")]
213 Tr1,
214 #[serde(rename = "us-2")]
215 Us2,
216 #[serde(rename = "de-1")]
217 De1,
218 #[serde(rename = "fi-1")]
219 Fi1
220}
221
222impl Default for Location {
223 fn default() -> Location {
224 Self::Ru1
225 }
226}