timeweb_rs/models/cluster_in.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 ClusterIn {
17 /// Название кластера
18 #[serde(rename = "name")]
19 pub name: String,
20 /// Описание кластера
21 #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
22 pub description: Option<String>,
23 /// Версия Kubernetes
24 #[serde(rename = "k8s_version")]
25 pub k8s_version: String,
26 /// Зона доступности
27 #[serde(rename = "availability_zone", skip_serializing_if = "Option::is_none")]
28 pub availability_zone: Option<AvailabilityZone>,
29 /// Тип используемого сетевого драйвера в кластере
30 #[serde(rename = "network_driver")]
31 pub network_driver: NetworkDriver,
32 /// Логическое значение, которое показывает, использовать ли Ingress в
33 /// кластере
34 #[serde(rename = "is_ingress", skip_serializing_if = "Option::is_none")]
35 pub is_ingress: Option<bool>,
36 /// Логическое значение, которое показывает, использовать ли Kubernetes
37 /// Dashboard в кластере
38 #[serde(rename = "is_k8s_dashboard", skip_serializing_if = "Option::is_none")]
39 pub is_k8s_dashboard: Option<bool>,
40 /// ID тарифа мастер-ноды. Нельзя передавать вместе с `configuration`
41 #[serde(rename = "preset_id", skip_serializing_if = "Option::is_none")]
42 pub preset_id: Option<i32>,
43 #[serde(rename = "configuration", skip_serializing_if = "Option::is_none")]
44 pub configuration: Option<Box<models::ClusterInConfiguration>>,
45 /// Количество мастер нод
46 #[serde(rename = "master_nodes_count", skip_serializing_if = "Option::is_none")]
47 pub master_nodes_count: Option<i32>,
48 /// Группы воркеров в кластере
49 #[serde(rename = "worker_groups", skip_serializing_if = "Option::is_none")]
50 pub worker_groups: Option<Vec<models::NodeGroupIn>>,
51 /// ID приватной сети
52 #[serde(rename = "network_id", skip_serializing_if = "Option::is_none")]
53 pub network_id: Option<String>,
54 /// ID проекта
55 #[serde(rename = "project_id", skip_serializing_if = "Option::is_none")]
56 pub project_id: Option<i32>,
57 #[serde(rename = "maintenance_slot", skip_serializing_if = "Option::is_none")]
58 pub maintenance_slot: Option<Box<models::ClusterInMaintenanceSlot>>,
59 #[serde(rename = "oidc_provider", skip_serializing_if = "Option::is_none")]
60 pub oidc_provider: Option<Box<models::ClusterInOidcProvider>>,
61 #[serde(
62 rename = "cluster_network_cidr",
63 skip_serializing_if = "Option::is_none"
64 )]
65 pub cluster_network_cidr: Option<Box<models::ClusterInClusterNetworkCidr>>
66}
67
68impl ClusterIn {
69 pub fn new(name: String, k8s_version: String, network_driver: NetworkDriver) -> ClusterIn {
70 ClusterIn {
71 name,
72 description: None,
73 k8s_version,
74 availability_zone: None,
75 network_driver,
76 is_ingress: None,
77 is_k8s_dashboard: None,
78 preset_id: None,
79 configuration: None,
80 master_nodes_count: None,
81 worker_groups: None,
82 network_id: None,
83 project_id: None,
84 maintenance_slot: None,
85 oidc_provider: None,
86 cluster_network_cidr: None
87 }
88 }
89}
90/// Зона доступности
91#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
92pub enum AvailabilityZone {
93 #[serde(rename = "spb-3")]
94 Spb3,
95 #[serde(rename = "msk-1")]
96 Msk1,
97 #[serde(rename = "ams-1")]
98 Ams1,
99 #[serde(rename = "fra-1")]
100 Fra1
101}
102
103impl Default for AvailabilityZone {
104 fn default() -> AvailabilityZone {
105 Self::Spb3
106 }
107}
108/// Тип используемого сетевого драйвера в кластере
109#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
110pub enum NetworkDriver {
111 #[serde(rename = "kuberouter")]
112 Kuberouter,
113 #[serde(rename = "calico")]
114 Calico,
115 #[serde(rename = "flannel")]
116 Flannel,
117 #[serde(rename = "cilium")]
118 Cilium
119}
120
121impl Default for NetworkDriver {
122 fn default() -> NetworkDriver {
123 Self::Kuberouter
124 }
125}