timeweb_rs/models/domain_request.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/// DomainRequest : Заявка на продление/регистрацию/трансфер домена.
16#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
17pub struct DomainRequest {
18 /// ID пользователя
19 #[serde(rename = "account_id")]
20 pub account_id: String,
21 /// Код авторизации для переноса домена.
22 #[serde(rename = "auth_code", deserialize_with = "Option::deserialize")]
23 pub auth_code: Option<String>,
24 /// Дата создания заявки.
25 #[serde(rename = "date")]
26 pub date: chrono::DateTime<chrono::FixedOffset>,
27 /// Идентификационный номер бандла, в который входит данная заявка (null -
28 /// если заявка не входит ни в один бандл).
29 #[serde(rename = "domain_bundle_id", deserialize_with = "Option::deserialize")]
30 pub domain_bundle_id: Option<String>,
31 /// Код ошибки трансфера домена.
32 #[serde(
33 rename = "error_code_transfer",
34 deserialize_with = "Option::deserialize"
35 )]
36 pub error_code_transfer: Option<String>,
37 /// Полное имя домена.
38 #[serde(rename = "fqdn")]
39 pub fqdn: String,
40 /// ID группы доменных зон.
41 #[serde(rename = "group_id")]
42 pub group_id: f64,
43 /// ID заявки.
44 #[serde(rename = "id")]
45 pub id: f64,
46 /// Это логическое значение, которое показывает включена ли услуга
47 /// \"Антиспам\" для домена
48 #[serde(rename = "is_antispam_enabled")]
49 pub is_antispam_enabled: bool,
50 /// Это логическое значение, которое показывает, включено ли автопродление
51 /// домена.
52 #[serde(rename = "is_autoprolong_enabled")]
53 pub is_autoprolong_enabled: bool,
54 /// Это логическое значение, которое показывает, включено ли скрытие данных
55 /// администратора домена для whois. Опция недоступна для доменов в зонах
56 /// .ru и .рф.
57 #[serde(rename = "is_whois_privacy_enabled")]
58 pub is_whois_privacy_enabled: bool,
59 /// Информационное сообщение о заявке.
60 #[serde(rename = "message", deserialize_with = "Option::deserialize")]
61 pub message: Option<String>,
62 /// Источник (способ) оплаты заявки.
63 #[serde(rename = "money_source", deserialize_with = "Option::deserialize")]
64 pub money_source: Option<MoneySource>,
65 #[serde(rename = "period")]
66 pub period: models::DomainPaymentPeriod,
67 /// Идентификационный номер персоны для заявки на регистрацию.
68 #[serde(rename = "person_id")]
69 pub person_id: f64,
70 #[serde(rename = "prime", deserialize_with = "Option::deserialize")]
71 pub prime: Option<models::DomainPrimeType>,
72 /// Количество дней до конца регистрации домена, за которые мы уведомим о
73 /// необходимости продления.
74 #[serde(rename = "soon_expire")]
75 pub soon_expire: f64,
76 /// Это значение используется для сортировки доменных зон в панели
77 /// управления.
78 #[serde(rename = "sort_order")]
79 pub sort_order: f64,
80 /// Тип заявки.
81 #[serde(rename = "type")]
82 pub r#type: Type
83}
84
85impl DomainRequest {
86 /// Заявка на продление/регистрацию/трансфер домена.
87 pub fn new(
88 account_id: String,
89 auth_code: Option<String>,
90 date: chrono::DateTime<chrono::FixedOffset>,
91 domain_bundle_id: Option<String>,
92 error_code_transfer: Option<String>,
93 fqdn: String,
94 group_id: f64,
95 id: f64,
96 is_antispam_enabled: bool,
97 is_autoprolong_enabled: bool,
98 is_whois_privacy_enabled: bool,
99 message: Option<String>,
100 money_source: Option<MoneySource>,
101 period: models::DomainPaymentPeriod,
102 person_id: f64,
103 prime: Option<models::DomainPrimeType>,
104 soon_expire: f64,
105 sort_order: f64,
106 r#type: Type
107 ) -> DomainRequest {
108 DomainRequest {
109 account_id,
110 auth_code,
111 date,
112 domain_bundle_id,
113 error_code_transfer,
114 fqdn,
115 group_id,
116 id,
117 is_antispam_enabled,
118 is_autoprolong_enabled,
119 is_whois_privacy_enabled,
120 message,
121 money_source,
122 period,
123 person_id,
124 prime,
125 soon_expire,
126 sort_order,
127 r#type
128 }
129 }
130}
131/// Источник (способ) оплаты заявки.
132#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
133pub enum MoneySource {
134 #[serde(rename = "use")]
135 Use,
136 #[serde(rename = "bonus")]
137 Bonus,
138 #[serde(rename = "invoice")]
139 Invoice
140}
141
142impl Default for MoneySource {
143 fn default() -> MoneySource {
144 Self::Use
145 }
146}
147/// Тип заявки.
148#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
149pub enum Type {
150 #[serde(rename = "request")]
151 Request,
152 #[serde(rename = "prolong")]
153 Prolong,
154 #[serde(rename = "transfer")]
155 Transfer
156}
157
158impl Default for Type {
159 fn default() -> Type {
160 Self::Request
161 }
162}