timeweb_rs/models/config_parameters.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/// ConfigParameters : Параметры базы данных
16#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
17pub struct ConfigParameters {
18 /// Интервал между значениями столбцов с атрибутом `AUTO_INCREMENT`
19 /// (`mysql5` | `mysql`).
20 #[serde(
21 rename = "auto_increment_increment",
22 skip_serializing_if = "Option::is_none"
23 )]
24 pub auto_increment_increment: Option<String>,
25 /// Начальное значение для столбцов с атрибутом `AUTO_INCREMENT` (`mysql5` |
26 /// `mysql`).
27 #[serde(
28 rename = "auto_increment_offset",
29 skip_serializing_if = "Option::is_none"
30 )]
31 pub auto_increment_offset: Option<String>,
32 /// Количество операций ввода-вывода в секунду `IOPS` (`mysql5` | `mysql`).
33 #[serde(rename = "innodb_io_capacity", skip_serializing_if = "Option::is_none")]
34 pub innodb_io_capacity: Option<String>,
35 /// Количество потоков ввода-вывода, используемых для операций очистки
36 /// (`mysql5` | `mysql`).
37 #[serde(
38 rename = "innodb_purge_threads",
39 skip_serializing_if = "Option::is_none"
40 )]
41 pub innodb_purge_threads: Option<String>,
42 /// Количество потоков ввода-вывода, используемых для операций чтения
43 /// (`mysql5` | `mysql`).
44 #[serde(
45 rename = "innodb_read_io_threads",
46 skip_serializing_if = "Option::is_none"
47 )]
48 pub innodb_read_io_threads: Option<String>,
49 /// Максимальное число потоков, которые могут исполняться (`mysql5` |
50 /// `mysql`).
51 #[serde(
52 rename = "innodb_thread_concurrency",
53 skip_serializing_if = "Option::is_none"
54 )]
55 pub innodb_thread_concurrency: Option<String>,
56 /// Количество потоков ввода-вывода, используемых для операций записи
57 /// (`mysql5` | `mysql`).
58 #[serde(
59 rename = "innodb_write_io_threads",
60 skip_serializing_if = "Option::is_none"
61 )]
62 pub innodb_write_io_threads: Option<String>,
63 /// Минимальный размер буфера (`mysql5` | `mysql`).
64 #[serde(rename = "join_buffer_size", skip_serializing_if = "Option::is_none")]
65 pub join_buffer_size: Option<String>,
66 /// Максимальный размер одного пакета, строки или параметра, отправляемого
67 /// функцией `mysql_stmt_send_long_data()` (`mysql5` | `mysql`).
68 #[serde(rename = "max_allowed_packet", skip_serializing_if = "Option::is_none")]
69 pub max_allowed_packet: Option<String>,
70 /// Максимальный размер пользовательских MEMORY-таблиц (`mysql5` | `mysql`).
71 #[serde(
72 rename = "max_heap_table_size",
73 skip_serializing_if = "Option::is_none"
74 )]
75 pub max_heap_table_size: Option<String>,
76 /// Доля измененных или удаленных записей в таблице, при которой процесс
77 /// автоочистки выполнит команду `ANALYZE` (`postgres` | `postgres14`|
78 /// `postgres15`).
79 #[serde(
80 rename = "autovacuum_analyze_scale_factor",
81 skip_serializing_if = "Option::is_none"
82 )]
83 pub autovacuum_analyze_scale_factor: Option<String>,
84 /// Задержка между запусками процесса фоновой записи (`postgres` |
85 /// `postgres14`| `postgres15`).
86 #[serde(rename = "bgwriter_delay", skip_serializing_if = "Option::is_none")]
87 pub bgwriter_delay: Option<String>,
88 /// Максимальное число элементов буферного кеша (`postgres` | `postgres14`|
89 /// `postgres15`).
90 #[serde(
91 rename = "bgwriter_lru_maxpages",
92 skip_serializing_if = "Option::is_none"
93 )]
94 pub bgwriter_lru_maxpages: Option<String>,
95 /// Время ожидания, по истечении которого будет выполняться проверка
96 /// состояния перекрестной блокировки (`postgres` | `postgres14`|
97 /// `postgres15`).
98 #[serde(rename = "deadlock_timeout", skip_serializing_if = "Option::is_none")]
99 pub deadlock_timeout: Option<String>,
100 /// Максимальный размер очереди записей индекса `GIN` (`postgres` |
101 /// `postgres14`| `postgres15`).
102 #[serde(
103 rename = "gin_pending_list_limit",
104 skip_serializing_if = "Option::is_none"
105 )]
106 pub gin_pending_list_limit: Option<String>,
107 /// Время простоя открытой транзакции, при превышении которого будет
108 /// завершена сессия с этой транзакцией (`postgres` | `postgres14`|
109 /// `postgres15`).
110 #[serde(
111 rename = "idle_in_transaction_session_timeout",
112 skip_serializing_if = "Option::is_none"
113 )]
114 pub idle_in_transaction_session_timeout: Option<String>,
115 /// Время простоя не открытой транзакции, при превышении которого будет
116 /// завершена сессия с этой транзакцией (`postgres` | `postgres14`|
117 /// `postgres15`).
118 #[serde(
119 rename = "idle_session_timeout",
120 skip_serializing_if = "Option::is_none"
121 )]
122 pub idle_session_timeout: Option<String>,
123 /// Значение количества элементов в списке `FROM` при превышении которого,
124 /// планировщик будет переносить в список явные инструкции `JOIN`
125 /// (`postgres` | `postgres14`| `postgres15`).
126 #[serde(
127 rename = "join_collapse_limit",
128 skip_serializing_if = "Option::is_none"
129 )]
130 pub join_collapse_limit: Option<String>,
131 /// Время ожидания освобождения блокировки (`postgres` | `postgres14`|
132 /// `postgres15`).
133 #[serde(rename = "lock_timeout", skip_serializing_if = "Option::is_none")]
134 pub lock_timeout: Option<String>,
135 /// Максимальное число транзакций, которые могут одновременно находиться в
136 /// подготовленном состоянии (`postgres` | `postgres14`| `postgres15`).
137 #[serde(
138 rename = "max_prepared_transactions",
139 skip_serializing_if = "Option::is_none"
140 )]
141 pub max_prepared_transactions: Option<String>,
142 /// Допустимое количество соединений (`postgres` | `postgres14`|
143 /// `postgres15` | `mysql`).
144 #[serde(rename = "max_connections", skip_serializing_if = "Option::is_none")]
145 pub max_connections: Option<String>,
146 /// Устанавливает количество буферов общей памяти, используемых сервером
147 /// (`postgres` | `postgres14`| `postgres15`).
148 #[serde(rename = "shared_buffers", skip_serializing_if = "Option::is_none")]
149 pub shared_buffers: Option<String>,
150 /// Устанавливает количество буферов дисковых страниц в общей памяти для WAL
151 /// (`postgres` | `postgres14`| `postgres15`).
152 #[serde(rename = "wal_buffers", skip_serializing_if = "Option::is_none")]
153 pub wal_buffers: Option<String>,
154 /// Устанавливает максимальное количество временных буферов, используемых
155 /// каждой сессией (`postgres` | `postgres14`| `postgres15`).
156 #[serde(rename = "temp_buffers", skip_serializing_if = "Option::is_none")]
157 pub temp_buffers: Option<String>,
158 /// Устанавливает максимальное количество памяти, используемое для рабочих
159 /// пространств запросов (`postgres` | `postgres14`| `postgres15`).
160 #[serde(rename = "work_mem", skip_serializing_if = "Option::is_none")]
161 pub work_mem: Option<String>,
162 /// Устанавливает режим SQL. Можно задать несколько режимов, разделяя их
163 /// запятой. (`mysql`).
164 #[serde(rename = "sql_mode", skip_serializing_if = "Option::is_none")]
165 pub sql_mode: Option<String>,
166 /// Параметр включает или отключает работу MySQL Query Cache (`mysql`).
167 #[serde(rename = "query_cache_type", skip_serializing_if = "Option::is_none")]
168 pub query_cache_type: Option<String>,
169 /// Размер в байтах, доступный для кэша запросов (`mysql`).
170 #[serde(rename = "query_cache_size", skip_serializing_if = "Option::is_none")]
171 pub query_cache_size: Option<String>
172}
173
174impl ConfigParameters {
175 /// Параметры базы данных
176 pub fn new() -> ConfigParameters {
177 ConfigParameters {
178 auto_increment_increment: None,
179 auto_increment_offset: None,
180 innodb_io_capacity: None,
181 innodb_purge_threads: None,
182 innodb_read_io_threads: None,
183 innodb_thread_concurrency: None,
184 innodb_write_io_threads: None,
185 join_buffer_size: None,
186 max_allowed_packet: None,
187 max_heap_table_size: None,
188 autovacuum_analyze_scale_factor: None,
189 bgwriter_delay: None,
190 bgwriter_lru_maxpages: None,
191 deadlock_timeout: None,
192 gin_pending_list_limit: None,
193 idle_in_transaction_session_timeout: None,
194 idle_session_timeout: None,
195 join_collapse_limit: None,
196 lock_timeout: None,
197 max_prepared_transactions: None,
198 max_connections: None,
199 shared_buffers: None,
200 wal_buffers: None,
201 temp_buffers: None,
202 work_mem: None,
203 sql_mode: None,
204 query_cache_type: None,
205 query_cache_size: None
206 }
207 }
208}