timeweb_rs/models/domain.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/// Domain : Домен
16#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
17pub struct Domain {
18 /// Допустимые периоды продления домена.
19 #[serde(rename = "allowed_buy_periods")]
20 pub allowed_buy_periods: Vec<models::DomainAllowedBuyPeriodsInner>,
21 /// Количество дней, оставшихся до конца срока регистрации домена.
22 #[serde(rename = "days_left")]
23 pub days_left: f64,
24 /// Статус домена.
25 #[serde(rename = "domain_status")]
26 pub domain_status: DomainStatus,
27 /// Дата окончания срока регистрации домена, для доменов без срока окончания
28 /// регистрации будет приходить 0000-00-00.
29 #[serde(rename = "expiration")]
30 pub expiration: String,
31 /// Полное имя домена.
32 #[serde(rename = "fqdn")]
33 pub fqdn: String,
34 /// ID домена.
35 #[serde(rename = "id")]
36 pub id: f64,
37 /// Ссылка на аватар домена.
38 #[serde(rename = "avatar_link", deserialize_with = "Option::deserialize")]
39 pub avatar_link: Option<String>,
40 /// Это логическое значение, которое показывает, включено ли автопродление
41 /// домена.
42 #[serde(
43 rename = "is_autoprolong_enabled",
44 deserialize_with = "Option::deserialize"
45 )]
46 pub is_autoprolong_enabled: Option<bool>,
47 /// Это логическое значение, которое показывает, является ли домен
48 /// премиальным.
49 #[serde(rename = "is_premium")]
50 pub is_premium: bool,
51 /// Это логическое значение, которое показывает, можно ли сейчас продлить
52 /// домен.
53 #[serde(rename = "is_prolong_allowed")]
54 pub is_prolong_allowed: bool,
55 /// Это логическое значение, которое показывает, является ли домен
56 /// техническим.
57 #[serde(rename = "is_technical")]
58 pub is_technical: bool,
59 /// Это логическое значение, которое показывает, включено ли скрытие данных
60 /// администратора домена для whois. Если приходит null, значит для данной
61 /// зоны эта услуга не доступна.
62 #[serde(
63 rename = "is_whois_privacy_enabled",
64 deserialize_with = "Option::deserialize"
65 )]
66 pub is_whois_privacy_enabled: Option<bool>,
67 /// Привязанный к домену IP-адрес.
68 #[serde(rename = "linked_ip", deserialize_with = "Option::deserialize")]
69 pub linked_ip: Option<String>,
70 /// До какого числа оплачен домен.
71 #[serde(rename = "paid_till", deserialize_with = "Option::deserialize")]
72 pub paid_till: Option<String>,
73 /// ID администратора, на которого зарегистрирован домен.
74 #[serde(rename = "person_id", deserialize_with = "Option::deserialize")]
75 pub person_id: Option<f64>,
76 /// Стоимость премиального домена.
77 #[serde(
78 rename = "premium_prolong_cost",
79 deserialize_with = "Option::deserialize"
80 )]
81 pub premium_prolong_cost: Option<f64>,
82 /// ID регистратора домена.
83 #[serde(rename = "provider", deserialize_with = "Option::deserialize")]
84 pub provider: Option<String>,
85 /// Статус заявки на продление/регистрацию/трансфер домена.
86 #[serde(rename = "request_status", deserialize_with = "Option::deserialize")]
87 pub request_status: Option<RequestStatus>,
88 /// Список поддоменов.
89 #[serde(rename = "subdomains")]
90 pub subdomains: Vec<models::Subdomain>,
91 /// ID доменной зоны.
92 #[serde(rename = "tld_id", deserialize_with = "Option::deserialize")]
93 pub tld_id: Option<f64>
94}
95
96impl Domain {
97 /// Домен
98 pub fn new(
99 allowed_buy_periods: Vec<models::DomainAllowedBuyPeriodsInner>,
100 days_left: f64,
101 domain_status: DomainStatus,
102 expiration: String,
103 fqdn: String,
104 id: f64,
105 avatar_link: Option<String>,
106 is_autoprolong_enabled: Option<bool>,
107 is_premium: bool,
108 is_prolong_allowed: bool,
109 is_technical: bool,
110 is_whois_privacy_enabled: Option<bool>,
111 linked_ip: Option<String>,
112 paid_till: Option<String>,
113 person_id: Option<f64>,
114 premium_prolong_cost: Option<f64>,
115 provider: Option<String>,
116 request_status: Option<RequestStatus>,
117 subdomains: Vec<models::Subdomain>,
118 tld_id: Option<f64>
119 ) -> Domain {
120 Domain {
121 allowed_buy_periods,
122 days_left,
123 domain_status,
124 expiration,
125 fqdn,
126 id,
127 avatar_link,
128 is_autoprolong_enabled,
129 is_premium,
130 is_prolong_allowed,
131 is_technical,
132 is_whois_privacy_enabled,
133 linked_ip,
134 paid_till,
135 person_id,
136 premium_prolong_cost,
137 provider,
138 request_status,
139 subdomains,
140 tld_id
141 }
142 }
143}
144/// Статус домена.
145#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
146pub enum DomainStatus {
147 #[serde(rename = "awaiting_payment")]
148 AwaitingPayment,
149 #[serde(rename = "expired")]
150 Expired,
151 #[serde(rename = "final_expired")]
152 FinalExpired,
153 #[serde(rename = "free")]
154 Free,
155 #[serde(rename = "no_paid")]
156 NoPaid,
157 #[serde(rename = "ns_based")]
158 NsBased,
159 #[serde(rename = "paid")]
160 Paid,
161 #[serde(rename = "soon_expire")]
162 SoonExpire,
163 #[serde(rename = "today_expired")]
164 TodayExpired
165}
166
167impl Default for DomainStatus {
168 fn default() -> DomainStatus {
169 Self::AwaitingPayment
170 }
171}
172/// Статус заявки на продление/регистрацию/трансфер домена.
173#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
174pub enum RequestStatus {
175 #[serde(rename = "prolongation_fail")]
176 ProlongationFail,
177 #[serde(rename = "prolongation_request")]
178 ProlongationRequest,
179 #[serde(rename = "registration_fail")]
180 RegistrationFail,
181 #[serde(rename = "registration_request")]
182 RegistrationRequest,
183 #[serde(rename = "transfer_fail")]
184 TransferFail,
185 #[serde(rename = "transfer_request")]
186 TransferRequest,
187 #[serde(rename = "awaiting_person")]
188 AwaitingPerson
189}
190
191impl Default for RequestStatus {
192 fn default() -> RequestStatus {
193 Self::ProlongationFail
194 }
195}