timeweb_rs/models/app.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/// App : Экземпляр приложения.
16#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
17pub struct App {
18 /// ID для каждого экземпляра приложения. Автоматически генерируется при
19 /// создании.
20 #[serde(rename = "id")]
21 pub id: f64,
22 /// Тип приложения.
23 #[serde(rename = "type")]
24 pub r#type: Type,
25 /// Удобочитаемое имя, установленное для приложения.
26 #[serde(rename = "name")]
27 pub name: String,
28 /// Статус приложения.
29 #[serde(rename = "status")]
30 pub status: Status,
31 #[serde(rename = "provider")]
32 pub provider: Box<models::AppProvider>,
33 /// IPv4-адрес приложения.
34 #[serde(rename = "ip")]
35 pub ip: String,
36 #[serde(rename = "domains")]
37 pub domains: Vec<models::AppDomainsInner>,
38 #[serde(rename = "framework")]
39 pub framework: Box<models::Frameworks>,
40 /// Локация сервера.
41 #[serde(rename = "location")]
42 pub location: Location,
43 #[serde(rename = "repository")]
44 pub repository: Box<models::Repository>,
45 /// Версия окружения.
46 #[serde(rename = "env_version", deserialize_with = "Option::deserialize")]
47 pub env_version: Option<String>,
48 /// Переменные окружения приложения. Объект с ключами и значениями типа
49 /// string.
50 #[serde(rename = "envs")]
51 pub envs: serde_json::Value,
52 /// Название ветки репозитория из которой собрано приложение.
53 #[serde(rename = "branch_name")]
54 pub branch_name: String,
55 /// Включен ли автоматический деплой.
56 #[serde(rename = "is_auto_deploy")]
57 pub is_auto_deploy: bool,
58 /// Хэш коммита из которого собрано приложеие.
59 #[serde(rename = "commit_sha")]
60 pub commit_sha: String,
61 /// Комментарий к приложению.
62 #[serde(rename = "comment")]
63 pub comment: String,
64 /// ID тарифа.
65 #[serde(rename = "preset_id")]
66 pub preset_id: f64,
67 /// Путь к директории с индексным файлом. Определен для приложений `type:
68 /// frontend`. Для приложений `type: backend` всегда null.
69 #[serde(rename = "index_dir", deserialize_with = "Option::deserialize")]
70 pub index_dir: Option<String>,
71 /// Команда сборки приложения.
72 #[serde(rename = "build_cmd")]
73 pub build_cmd: String,
74 /// Ссылка на аватар приложения.
75 #[serde(rename = "avatar_link", deserialize_with = "Option::deserialize")]
76 pub avatar_link: Option<String>,
77 /// Команда для запуска приложения. Определена для приложений `type:
78 /// backend`. Для приложений `type: frontend` всегда null.
79 #[serde(rename = "run_cmd", deserialize_with = "Option::deserialize")]
80 pub run_cmd: Option<String>,
81 #[serde(rename = "configuration", deserialize_with = "Option::deserialize")]
82 pub configuration: Option<Box<models::AppConfiguration>>,
83 #[serde(rename = "disk_status", deserialize_with = "Option::deserialize")]
84 pub disk_status: Option<Box<models::AppDiskStatus>>,
85 /// Включен ли агент QEMU.
86 #[serde(rename = "is_qemu_agent")]
87 pub is_qemu_agent: bool,
88 /// Язык программирования приложения.
89 #[serde(rename = "language")]
90 pub language: String,
91 /// Время запуска приложения.
92 #[serde(rename = "start_time")]
93 pub start_time: chrono::DateTime<chrono::FixedOffset>
94}
95
96impl App {
97 /// Экземпляр приложения.
98 pub fn new(
99 id: f64,
100 r#type: Type,
101 name: String,
102 status: Status,
103 provider: models::AppProvider,
104 ip: String,
105 domains: Vec<models::AppDomainsInner>,
106 framework: models::Frameworks,
107 location: Location,
108 repository: models::Repository,
109 env_version: Option<String>,
110 envs: serde_json::Value,
111 branch_name: String,
112 is_auto_deploy: bool,
113 commit_sha: String,
114 comment: String,
115 preset_id: f64,
116 index_dir: Option<String>,
117 build_cmd: String,
118 avatar_link: Option<String>,
119 run_cmd: Option<String>,
120 configuration: Option<models::AppConfiguration>,
121 disk_status: Option<models::AppDiskStatus>,
122 is_qemu_agent: bool,
123 language: String,
124 start_time: chrono::DateTime<chrono::FixedOffset>
125 ) -> App {
126 App {
127 id,
128 r#type,
129 name,
130 status,
131 provider: Box::new(provider),
132 ip,
133 domains,
134 framework: Box::new(framework),
135 location,
136 repository: Box::new(repository),
137 env_version,
138 envs,
139 branch_name,
140 is_auto_deploy,
141 commit_sha,
142 comment,
143 preset_id,
144 index_dir,
145 build_cmd,
146 avatar_link,
147 run_cmd,
148 configuration: if let Some(x) = configuration {
149 Some(Box::new(x))
150 } else {
151 None
152 },
153 disk_status: if let Some(x) = disk_status {
154 Some(Box::new(x))
155 } else {
156 None
157 },
158 is_qemu_agent,
159 language,
160 start_time
161 }
162 }
163}
164/// Тип приложения.
165#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
166pub enum Type {
167 #[serde(rename = "backend")]
168 Backend,
169 #[serde(rename = "frontend")]
170 Frontend
171}
172
173impl Default for Type {
174 fn default() -> Type {
175 Self::Backend
176 }
177}
178/// Статус приложения.
179#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
180pub enum Status {
181 #[serde(rename = "active")]
182 Active,
183 #[serde(rename = "paused")]
184 Paused,
185 #[serde(rename = "no_paid")]
186 NoPaid,
187 #[serde(rename = "deploy")]
188 Deploy,
189 #[serde(rename = "failure")]
190 Failure,
191 #[serde(rename = "startup_error")]
192 StartupError,
193 #[serde(rename = "new")]
194 New,
195 #[serde(rename = "reboot")]
196 Reboot
197}
198
199impl Default for Status {
200 fn default() -> Status {
201 Self::Active
202 }
203}
204/// Локация сервера.
205#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
206pub enum Location {
207 #[serde(rename = "ru-1")]
208 Ru1,
209 #[serde(rename = "pl-1")]
210 Pl1,
211 #[serde(rename = "nl-1")]
212 Nl1
213}
214
215impl Default for Location {
216 fn default() -> Location {
217 Self::Ru1
218 }
219}