timeweb_rs/models/create_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#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct CreateBalancer {
17 /// Удобочитаемое имя, установленное для балансировщика. Должно быть
18 /// уникальным в рамках аккаунта
19 #[serde(rename = "name")]
20 pub name: String,
21 /// Алгоритм переключений балансировщика.
22 #[serde(rename = "algo")]
23 pub algo: Algo,
24 /// Это логическое значение, которое показывает, сохраняется ли сессия.
25 #[serde(rename = "is_sticky")]
26 pub is_sticky: bool,
27 /// Это логическое значение, которое показывает, выступает ли балансировщик
28 /// в качестве прокси.
29 #[serde(rename = "is_use_proxy")]
30 pub is_use_proxy: bool,
31 /// Это логическое значение, которое показывает, требуется ли
32 /// перенаправление на SSL.
33 #[serde(rename = "is_ssl")]
34 pub is_ssl: bool,
35 /// Это логическое значение, которое показывает, выдает ли балансировщик
36 /// сигнал о проверке жизнеспособности.
37 #[serde(rename = "is_keepalive")]
38 pub is_keepalive: bool,
39 /// Протокол.
40 #[serde(rename = "proto")]
41 pub proto: Proto,
42 /// Порт балансировщика.
43 #[serde(rename = "port")]
44 pub port: f64,
45 /// Адрес балансировщика.
46 #[serde(rename = "path")]
47 pub path: String,
48 /// Интервал проверки.
49 #[serde(rename = "inter")]
50 pub inter: f64,
51 /// Таймаут ответа балансировщика.
52 #[serde(rename = "timeout")]
53 pub timeout: f64,
54 /// Порог количества ошибок.
55 #[serde(rename = "fall")]
56 pub fall: f64,
57 /// Порог количества успешных ответов.
58 #[serde(rename = "rise")]
59 pub rise: f64,
60 /// Максимальное количество соединений.
61 #[serde(rename = "maxconn", skip_serializing_if = "Option::is_none")]
62 pub maxconn: Option<f64>,
63 /// Таймаут подключения.
64 #[serde(rename = "connect_timeout", skip_serializing_if = "Option::is_none")]
65 pub connect_timeout: Option<f64>,
66 /// Таймаут клиента.
67 #[serde(rename = "client_timeout", skip_serializing_if = "Option::is_none")]
68 pub client_timeout: Option<f64>,
69 /// Таймаут сервера.
70 #[serde(rename = "server_timeout", skip_serializing_if = "Option::is_none")]
71 pub server_timeout: Option<f64>,
72 /// Таймаут HTTP запроса.
73 #[serde(
74 rename = "httprequest_timeout",
75 skip_serializing_if = "Option::is_none"
76 )]
77 pub httprequest_timeout: Option<f64>,
78 /// ID тарифа.
79 #[serde(rename = "preset_id")]
80 pub preset_id: f64,
81 #[serde(rename = "network", skip_serializing_if = "Option::is_none")]
82 pub network: Option<Box<models::Network>>,
83 #[serde(rename = "availability_zone", skip_serializing_if = "Option::is_none")]
84 pub availability_zone: Option<models::AvailabilityZone>,
85 /// ID проекта
86 #[serde(rename = "project_id", skip_serializing_if = "Option::is_none")]
87 pub project_id: Option<i32>,
88 #[serde(rename = "certificates", skip_serializing_if = "Option::is_none")]
89 pub certificates: Option<Box<models::CreateBalancerCertificates>>
90}
91
92impl CreateBalancer {
93 pub fn new(
94 name: String,
95 algo: Algo,
96 is_sticky: bool,
97 is_use_proxy: bool,
98 is_ssl: bool,
99 is_keepalive: bool,
100 proto: Proto,
101 port: f64,
102 path: String,
103 inter: f64,
104 timeout: f64,
105 fall: f64,
106 rise: f64,
107 preset_id: f64
108 ) -> CreateBalancer {
109 CreateBalancer {
110 name,
111 algo,
112 is_sticky,
113 is_use_proxy,
114 is_ssl,
115 is_keepalive,
116 proto,
117 port,
118 path,
119 inter,
120 timeout,
121 fall,
122 rise,
123 maxconn: None,
124 connect_timeout: None,
125 client_timeout: None,
126 server_timeout: None,
127 httprequest_timeout: None,
128 preset_id,
129 network: None,
130 availability_zone: None,
131 project_id: None,
132 certificates: None
133 }
134 }
135}
136/// Алгоритм переключений балансировщика.
137#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
138pub enum Algo {
139 #[serde(rename = "roundrobin")]
140 Roundrobin,
141 #[serde(rename = "leastconn")]
142 Leastconn
143}
144
145impl Default for Algo {
146 fn default() -> Algo {
147 Self::Roundrobin
148 }
149}
150/// Протокол.
151#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
152pub enum Proto {
153 #[serde(rename = "http")]
154 Http,
155 #[serde(rename = "http2")]
156 Http2,
157 #[serde(rename = "https")]
158 Https,
159 #[serde(rename = "tcp")]
160 Tcp
161}
162
163impl Default for Proto {
164 fn default() -> Proto {
165 Self::Http
166 }
167}