timeweb_rs/models/balancer.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/// Balancer : Балансировщик
16#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
17pub struct Balancer {
18 /// ID для каждого экземпляра балансировщика. Автоматически генерируется при
19 /// создании.
20 #[serde(rename = "id")]
21 pub id: f64,
22 /// ID пользователя.
23 #[serde(rename = "account_id", skip_serializing_if = "Option::is_none")]
24 pub account_id: Option<String>,
25 /// Алгоритм переключений балансировщика.
26 #[serde(rename = "algo")]
27 pub algo: Algo,
28 /// Значение времени, указанное в комбинированном формате даты и времени
29 /// ISO8601, которое представляет, когда был создан балансировщик.
30 #[serde(rename = "created_at")]
31 pub created_at: chrono::DateTime<chrono::FixedOffset>,
32 /// Порог количества ошибок.
33 #[serde(rename = "fall")]
34 pub fall: f64,
35 /// Интервал проверки.
36 #[serde(rename = "inter")]
37 pub inter: f64,
38 /// IP-адрес сетевого интерфейса IPv4.
39 #[serde(rename = "ip", deserialize_with = "Option::deserialize")]
40 pub ip: Option<String>,
41 /// Локальный IP-адрес сетевого интерфейса IPv4.
42 #[serde(rename = "local_ip", deserialize_with = "Option::deserialize")]
43 pub local_ip: Option<String>,
44 /// Это логическое значение, которое показывает, выдает ли балансировщик
45 /// сигнал о проверке жизнеспособности.
46 #[serde(rename = "is_keepalive")]
47 pub is_keepalive: bool,
48 /// Удобочитаемое имя, установленное для балансировщика.
49 #[serde(rename = "name")]
50 pub name: String,
51 /// Адрес балансировщика.
52 #[serde(rename = "path")]
53 pub path: String,
54 /// Порт балансировщика.
55 #[serde(rename = "port")]
56 pub port: f64,
57 /// Протокол.
58 #[serde(rename = "proto")]
59 pub proto: Proto,
60 /// Порог количества успешных ответов.
61 #[serde(rename = "rise")]
62 pub rise: f64,
63 /// Максимальное количество соединений.
64 #[serde(rename = "maxconn")]
65 pub maxconn: f64,
66 /// Таймаут подключения.
67 #[serde(rename = "connect_timeout")]
68 pub connect_timeout: f64,
69 /// Таймаут клиента.
70 #[serde(rename = "client_timeout")]
71 pub client_timeout: f64,
72 /// Таймаут сервера.
73 #[serde(rename = "server_timeout")]
74 pub server_timeout: f64,
75 /// Таймаут HTTP запроса.
76 #[serde(rename = "httprequest_timeout")]
77 pub httprequest_timeout: f64,
78 /// ID тарифа.
79 #[serde(rename = "preset_id")]
80 pub preset_id: f64,
81 /// Это логическое значение, которое показывает, требуется ли
82 /// перенаправление на SSL.
83 #[serde(rename = "is_ssl")]
84 pub is_ssl: bool,
85 /// Статус балансировщика.
86 #[serde(rename = "status")]
87 pub status: Status,
88 /// Это логическое значение, которое показывает, сохраняется ли сессия.
89 #[serde(rename = "is_sticky")]
90 pub is_sticky: bool,
91 /// Таймаут ответа балансировщика.
92 #[serde(rename = "timeout")]
93 pub timeout: f64,
94 /// Ссылка на аватар балансировщика.
95 #[serde(rename = "avatar_link", deserialize_with = "Option::deserialize")]
96 pub avatar_link: Option<String>,
97 /// Это логическое значение, которое показывает, выступает ли балансировщик
98 /// в качестве прокси.
99 #[serde(rename = "is_use_proxy")]
100 pub is_use_proxy: bool,
101 #[serde(rename = "rules")]
102 pub rules: Vec<models::Rule>,
103 /// Список IP-адресов, привязанных к балансировщику
104 #[serde(rename = "ips")]
105 pub ips: Vec<String>,
106 /// Географическое расположение балансировщика
107 #[serde(rename = "location")]
108 pub location: Location,
109 #[serde(rename = "availability_zone")]
110 pub availability_zone: models::AvailabilityZone,
111 /// ID проекта
112 #[serde(rename = "project_id")]
113 pub project_id: i32,
114 /// Список сетей сервера.
115 #[serde(rename = "networks")]
116 pub networks: Vec<models::BalancerNetworksInner>
117}
118
119impl Balancer {
120 /// Балансировщик
121 pub fn new(
122 id: f64,
123 algo: Algo,
124 created_at: chrono::DateTime<chrono::FixedOffset>,
125 fall: f64,
126 inter: f64,
127 ip: Option<String>,
128 local_ip: Option<String>,
129 is_keepalive: bool,
130 name: String,
131 path: String,
132 port: f64,
133 proto: Proto,
134 rise: f64,
135 maxconn: f64,
136 connect_timeout: f64,
137 client_timeout: f64,
138 server_timeout: f64,
139 httprequest_timeout: f64,
140 preset_id: f64,
141 is_ssl: bool,
142 status: Status,
143 is_sticky: bool,
144 timeout: f64,
145 avatar_link: Option<String>,
146 is_use_proxy: bool,
147 rules: Vec<models::Rule>,
148 ips: Vec<String>,
149 location: Location,
150 availability_zone: models::AvailabilityZone,
151 project_id: i32,
152 networks: Vec<models::BalancerNetworksInner>
153 ) -> Balancer {
154 Balancer {
155 id,
156 account_id: None,
157 algo,
158 created_at,
159 fall,
160 inter,
161 ip,
162 local_ip,
163 is_keepalive,
164 name,
165 path,
166 port,
167 proto,
168 rise,
169 maxconn,
170 connect_timeout,
171 client_timeout,
172 server_timeout,
173 httprequest_timeout,
174 preset_id,
175 is_ssl,
176 status,
177 is_sticky,
178 timeout,
179 avatar_link,
180 is_use_proxy,
181 rules,
182 ips,
183 location,
184 availability_zone,
185 project_id,
186 networks
187 }
188 }
189}
190/// Алгоритм переключений балансировщика.
191#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
192pub enum Algo {
193 #[serde(rename = "roundrobin")]
194 Roundrobin,
195 #[serde(rename = "leastconn")]
196 Leastconn
197}
198
199impl Default for Algo {
200 fn default() -> Algo {
201 Self::Roundrobin
202 }
203}
204/// Протокол.
205#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
206pub enum Proto {
207 #[serde(rename = "http")]
208 Http,
209 #[serde(rename = "http2")]
210 Http2,
211 #[serde(rename = "https")]
212 Https,
213 #[serde(rename = "tcp")]
214 Tcp
215}
216
217impl Default for Proto {
218 fn default() -> Proto {
219 Self::Http
220 }
221}
222/// Статус балансировщика.
223#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
224pub enum Status {
225 #[serde(rename = "started")]
226 Started,
227 #[serde(rename = "stoped")]
228 Stoped,
229 #[serde(rename = "starting")]
230 Starting,
231 #[serde(rename = "no_paid")]
232 NoPaid
233}
234
235impl Default for Status {
236 fn default() -> Status {
237 Self::Started
238 }
239}
240/// Географическое расположение балансировщика
241#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
242pub enum Location {
243 #[serde(rename = "ru-1")]
244 Ru1,
245 #[serde(rename = "pl-1")]
246 Pl1
247}
248
249impl Default for Location {
250 fn default() -> Location {
251 Self::Ru1
252 }
253}