timeweb_rs/models/bucket.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/// Bucket : Хранилище S3
16#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
17pub struct Bucket {
18 /// ID для каждого экземпляра хранилища. Автоматически генерируется при
19 /// создании.
20 #[serde(rename = "id")]
21 pub id: f64,
22 /// Удобочитаемое имя, установленное для хранилища.
23 #[serde(rename = "name")]
24 pub name: String,
25 /// Комментарий к хранилищу.
26 #[serde(rename = "description")]
27 pub description: String,
28 #[serde(rename = "disk_stats")]
29 pub disk_stats: Box<models::BucketDiskStats>,
30 /// Тип хранилища.
31 #[serde(rename = "type")]
32 pub r#type: Type,
33 /// ID тарифа хранилища.
34 #[serde(rename = "preset_id", deserialize_with = "Option::deserialize")]
35 pub preset_id: Option<f64>,
36 /// ID конфигуратора хранилища.
37 #[serde(rename = "configurator_id", deserialize_with = "Option::deserialize")]
38 pub configurator_id: Option<f64>,
39 /// Ссылка на аватар хранилища.
40 #[serde(rename = "avatar_link", deserialize_with = "Option::deserialize")]
41 pub avatar_link: Option<String>,
42 /// Статус хранилища.
43 #[serde(rename = "status")]
44 pub status: Status,
45 /// Количество файлов в хранилище.
46 #[serde(rename = "object_amount")]
47 pub object_amount: f64,
48 /// Регион хранилища.
49 #[serde(rename = "location")]
50 pub location: String,
51 /// Адрес хранилища для подключения.
52 #[serde(rename = "hostname")]
53 pub hostname: String,
54 /// Ключ доступа от хранилища.
55 #[serde(rename = "access_key")]
56 pub access_key: String,
57 /// Секретный ключ доступа от хранилища.
58 #[serde(rename = "secret_key")]
59 pub secret_key: String,
60 /// Дата перемещения в карантин.
61 #[serde(
62 rename = "moved_in_quarantine_at",
63 deserialize_with = "Option::deserialize"
64 )]
65 pub moved_in_quarantine_at: Option<chrono::DateTime<chrono::FixedOffset>>,
66 /// Класс хранилища.
67 #[serde(rename = "storage_class")]
68 pub storage_class: StorageClass,
69 /// ID проекта.
70 #[serde(rename = "project_id")]
71 pub project_id: f64,
72 /// ID тарифа.
73 #[serde(rename = "rate_id")]
74 pub rate_id: f64,
75 #[serde(rename = "website_config", deserialize_with = "Option::deserialize")]
76 pub website_config: Option<Box<models::BucketWebsiteConfig>>,
77 /// Разрешено ли автоматическое повышение тарифа.
78 #[serde(rename = "is_allow_auto_upgrade")]
79 pub is_allow_auto_upgrade: bool
80}
81
82impl Bucket {
83 /// Хранилище S3
84 pub fn new(
85 id: f64,
86 name: String,
87 description: String,
88 disk_stats: models::BucketDiskStats,
89 r#type: Type,
90 preset_id: Option<f64>,
91 configurator_id: Option<f64>,
92 avatar_link: Option<String>,
93 status: Status,
94 object_amount: f64,
95 location: String,
96 hostname: String,
97 access_key: String,
98 secret_key: String,
99 moved_in_quarantine_at: Option<chrono::DateTime<chrono::FixedOffset>>,
100 storage_class: StorageClass,
101 project_id: f64,
102 rate_id: f64,
103 website_config: Option<models::BucketWebsiteConfig>,
104 is_allow_auto_upgrade: bool
105 ) -> Bucket {
106 Bucket {
107 id,
108 name,
109 description,
110 disk_stats: Box::new(disk_stats),
111 r#type,
112 preset_id,
113 configurator_id,
114 avatar_link,
115 status,
116 object_amount,
117 location,
118 hostname,
119 access_key,
120 secret_key,
121 moved_in_quarantine_at,
122 storage_class,
123 project_id,
124 rate_id,
125 website_config: if let Some(x) = website_config {
126 Some(Box::new(x))
127 } else {
128 None
129 },
130 is_allow_auto_upgrade
131 }
132 }
133}
134/// Тип хранилища.
135#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
136pub enum Type {
137 #[serde(rename = "private")]
138 Private,
139 #[serde(rename = "public")]
140 Public
141}
142
143impl Default for Type {
144 fn default() -> Type {
145 Self::Private
146 }
147}
148/// Статус хранилища.
149#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
150pub enum Status {
151 #[serde(rename = "no_paid")]
152 NoPaid,
153 #[serde(rename = "created")]
154 Created,
155 #[serde(rename = "transfer")]
156 Transfer
157}
158
159impl Default for Status {
160 fn default() -> Status {
161 Self::NoPaid
162 }
163}
164/// Класс хранилища.
165#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
166pub enum StorageClass {
167 #[serde(rename = "cold")]
168 Cold,
169 #[serde(rename = "hot")]
170 Hot
171}
172
173impl Default for StorageClass {
174 fn default() -> StorageClass {
175 Self::Cold
176 }
177}