timeweb_rs/models/db.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/// Db : База данных
16#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
17pub struct Db {
18 /// ID для каждого экземпляра базы данных. Автоматически генерируется при
19 /// создании.
20 #[serde(rename = "id")]
21 pub id: f64,
22 /// Значение времени, указанное в комбинированном формате даты и времени
23 /// ISO8601, которое представляет, когда была создана база данных.
24 #[serde(rename = "created_at")]
25 pub created_at: String,
26 /// ID пользователя.
27 #[serde(rename = "account_id")]
28 pub account_id: String,
29 /// Логин для подключения к базе данных.
30 #[serde(rename = "login")]
31 pub login: String,
32 /// Локация сервера.
33 #[serde(rename = "location", skip_serializing_if = "Option::is_none")]
34 pub location: Option<Location>,
35 /// Пароль для подключения к базе данных.
36 #[serde(rename = "password")]
37 pub password: String,
38 /// Название базы данных.
39 #[serde(rename = "name")]
40 pub name: String,
41 /// Хост.
42 #[serde(rename = "host", deserialize_with = "Option::deserialize")]
43 pub host: Option<String>,
44 #[serde(rename = "type")]
45 pub r#type: models::DbType,
46 /// Тип хеширования базы данных (mysql5 | mysql | postgres).
47 #[serde(rename = "hash_type", deserialize_with = "Option::deserialize")]
48 pub hash_type: Option<HashType>,
49 /// Порт
50 #[serde(rename = "port")]
51 pub port: i32,
52 /// IP-адрес сетевого интерфейса IPv4.
53 #[serde(rename = "ip", deserialize_with = "Option::deserialize")]
54 pub ip: Option<String>,
55 /// IP-адрес локального сетевого интерфейса IPv4.
56 #[serde(rename = "local_ip", deserialize_with = "Option::deserialize")]
57 pub local_ip: Option<String>,
58 /// Текущий статус базы данных.
59 #[serde(rename = "status")]
60 pub status: Status,
61 /// ID тарифа.
62 #[serde(rename = "preset_id")]
63 pub preset_id: i32,
64 #[serde(rename = "disk_stats", deserialize_with = "Option::deserialize")]
65 pub disk_stats: Option<Box<models::DbDiskStats>>,
66 #[serde(rename = "config_parameters")]
67 pub config_parameters: Box<models::ConfigParameters>,
68 /// Это логическое значение, которое показывает, доступна ли база данных
69 /// только по локальному IP адресу.
70 #[serde(rename = "is_only_local_ip_access")]
71 pub is_only_local_ip_access: bool,
72 #[serde(rename = "availability_zone")]
73 pub availability_zone: models::AvailabilityZone
74}
75
76impl Db {
77 /// База данных
78 pub fn new(
79 id: f64,
80 created_at: String,
81 account_id: String,
82 login: String,
83 password: String,
84 name: String,
85 host: Option<String>,
86 r#type: models::DbType,
87 hash_type: Option<HashType>,
88 port: i32,
89 ip: Option<String>,
90 local_ip: Option<String>,
91 status: Status,
92 preset_id: i32,
93 disk_stats: Option<models::DbDiskStats>,
94 config_parameters: models::ConfigParameters,
95 is_only_local_ip_access: bool,
96 availability_zone: models::AvailabilityZone
97 ) -> Db {
98 Db {
99 id,
100 created_at,
101 account_id,
102 login,
103 location: None,
104 password,
105 name,
106 host,
107 r#type,
108 hash_type,
109 port,
110 ip,
111 local_ip,
112 status,
113 preset_id,
114 disk_stats: if let Some(x) = disk_stats {
115 Some(Box::new(x))
116 } else {
117 None
118 },
119 config_parameters: Box::new(config_parameters),
120 is_only_local_ip_access,
121 availability_zone
122 }
123 }
124}
125/// Локация сервера.
126#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
127pub enum Location {
128 #[serde(rename = "ru-1")]
129 Ru1,
130 #[serde(rename = "ru-2")]
131 Ru2,
132 #[serde(rename = "pl-1")]
133 Pl1,
134 #[serde(rename = "kz-1")]
135 Kz1
136}
137
138impl Default for Location {
139 fn default() -> Location {
140 Self::Ru1
141 }
142}
143/// Тип хеширования базы данных (mysql5 | mysql | postgres).
144#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
145pub enum HashType {
146 #[serde(rename = "caching_sha2")]
147 CachingSha2,
148 #[serde(rename = "mysql_native")]
149 MysqlNative
150}
151
152impl Default for HashType {
153 fn default() -> HashType {
154 Self::CachingSha2
155 }
156}
157/// Текущий статус базы данных.
158#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
159pub enum Status {
160 #[serde(rename = "started")]
161 Started,
162 #[serde(rename = "starting")]
163 Starting,
164 #[serde(rename = "stopped")]
165 Stopped,
166 #[serde(rename = "no_paid")]
167 NoPaid
168}
169
170impl Default for Status {
171 fn default() -> Status {
172 Self::Started
173 }
174}