/*
* Документация публичного API
*
* # Введение 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.
*
* The version of the OpenAPI document: 1.0.0
* Contact: info@timeweb.cloud
* Generated by: https://openapi-generator.tech
*/
use serde::{Deserialize, Serialize};
use crate::models;
/// DbExtension : Расширение базы данных. Для кластеров PostgreSQL доступны
/// расширения PostgreSQL, для кластеров RabbitMQ — плагины RabbitMQ. Если
/// расширение не подходит типу кластера, вернется ошибка `invalid_extension`.
/// Расширение базы данных. Для кластеров PostgreSQL доступны расширения
/// PostgreSQL, для кластеров RabbitMQ — плагины RabbitMQ. Если расширение не
/// подходит типу кластера, вернется ошибка `invalid_extension`.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum DbExtension {
#[serde(rename = "pg_stat_statements")]
PgStatStatements,
#[serde(rename = "postgres_fdw")]
PostgresFdw,
#[serde(rename = "timescaledb")]
Timescaledb,
#[serde(rename = "postgis")]
Postgis,
#[serde(rename = "postgis_topology")]
PostgisTopology,
#[serde(rename = "uuid-ossp")]
UuidOssp,
#[serde(rename = "amcheck")]
Amcheck,
#[serde(rename = "pg_stat_kcache")]
PgStatKcache,
#[serde(rename = "pg_trgm")]
PgTrgm,
#[serde(rename = "pgcrypto")]
Pgcrypto,
#[serde(rename = "pgvector")]
Pgvector,
#[serde(rename = "citext")]
Citext,
#[serde(rename = "pgagent")]
Pgagent,
#[serde(rename = "rabbitmq_amqp1_0")]
RabbitmqAmqp10,
#[serde(rename = "rabbitmq_auth_backend_cache")]
RabbitmqAuthBackendCache,
#[serde(rename = "rabbitmq_auth_backend_http")]
RabbitmqAuthBackendHttp,
#[serde(rename = "rabbitmq_auth_backend_ldap")]
RabbitmqAuthBackendLdap,
#[serde(rename = "rabbitmq_auth_backend_oauth2")]
RabbitmqAuthBackendOauth2,
#[serde(rename = "rabbitmq_auth_mechanism_ssl")]
RabbitmqAuthMechanismSsl,
#[serde(rename = "rabbitmq_consistent_hash_exchange")]
RabbitmqConsistentHashExchange,
#[serde(rename = "rabbitmq_delayed_message_exchange")]
RabbitmqDelayedMessageExchange,
#[serde(rename = "rabbitmq_event_exchange")]
RabbitmqEventExchange,
#[serde(rename = "rabbitmq_federation")]
RabbitmqFederation,
#[serde(rename = "rabbitmq_federation_management")]
RabbitmqFederationManagement,
#[serde(rename = "rabbitmq_federation_prometheus")]
RabbitmqFederationPrometheus,
#[serde(rename = "rabbitmq_jms_topic_exchange")]
RabbitmqJmsTopicExchange,
#[serde(rename = "rabbitmq_mqtt")]
RabbitmqMqtt,
#[serde(rename = "rabbitmq_peer_discovery_aws")]
RabbitmqPeerDiscoveryAws,
#[serde(rename = "rabbitmq_peer_discovery_common")]
RabbitmqPeerDiscoveryCommon,
#[serde(rename = "rabbitmq_peer_discovery_consul")]
RabbitmqPeerDiscoveryConsul,
#[serde(rename = "rabbitmq_peer_discovery_etcd")]
RabbitmqPeerDiscoveryEtcd,
#[serde(rename = "rabbitmq_peer_discovery_k8s")]
RabbitmqPeerDiscoveryK8s,
#[serde(rename = "rabbitmq_prometheus")]
RabbitmqPrometheus,
#[serde(rename = "rabbitmq_random_exchange")]
RabbitmqRandomExchange,
#[serde(rename = "rabbitmq_recent_history_exchange")]
RabbitmqRecentHistoryExchange,
#[serde(rename = "rabbitmq_sharding")]
RabbitmqSharding,
#[serde(rename = "rabbitmq_shovel")]
RabbitmqShovel,
#[serde(rename = "rabbitmq_shovel_management")]
RabbitmqShovelManagement,
#[serde(rename = "rabbitmq_shovel_prometheus")]
RabbitmqShovelPrometheus,
#[serde(rename = "rabbitmq_stomp")]
RabbitmqStomp,
#[serde(rename = "rabbitmq_stream")]
RabbitmqStream,
#[serde(rename = "rabbitmq_stream_management")]
RabbitmqStreamManagement,
#[serde(rename = "rabbitmq_top")]
RabbitmqTop,
#[serde(rename = "rabbitmq_tracing")]
RabbitmqTracing,
#[serde(rename = "rabbitmq_trust_store")]
RabbitmqTrustStore,
#[serde(rename = "rabbitmq_web_mqtt")]
RabbitmqWebMqtt,
#[serde(rename = "rabbitmq_web_stomp")]
RabbitmqWebStomp
}
impl std::fmt::Display for DbExtension {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
match self {
Self::PgStatStatements => write!(f, "pg_stat_statements"),
Self::PostgresFdw => write!(f, "postgres_fdw"),
Self::Timescaledb => write!(f, "timescaledb"),
Self::Postgis => write!(f, "postgis"),
Self::PostgisTopology => write!(f, "postgis_topology"),
Self::UuidOssp => write!(f, "uuid-ossp"),
Self::Amcheck => write!(f, "amcheck"),
Self::PgStatKcache => write!(f, "pg_stat_kcache"),
Self::PgTrgm => write!(f, "pg_trgm"),
Self::Pgcrypto => write!(f, "pgcrypto"),
Self::Pgvector => write!(f, "pgvector"),
Self::Citext => write!(f, "citext"),
Self::Pgagent => write!(f, "pgagent"),
Self::RabbitmqAmqp10 => write!(f, "rabbitmq_amqp1_0"),
Self::RabbitmqAuthBackendCache => write!(f, "rabbitmq_auth_backend_cache"),
Self::RabbitmqAuthBackendHttp => write!(f, "rabbitmq_auth_backend_http"),
Self::RabbitmqAuthBackendLdap => write!(f, "rabbitmq_auth_backend_ldap"),
Self::RabbitmqAuthBackendOauth2 => write!(f, "rabbitmq_auth_backend_oauth2"),
Self::RabbitmqAuthMechanismSsl => write!(f, "rabbitmq_auth_mechanism_ssl"),
Self::RabbitmqConsistentHashExchange => write!(f, "rabbitmq_consistent_hash_exchange"),
Self::RabbitmqDelayedMessageExchange => write!(f, "rabbitmq_delayed_message_exchange"),
Self::RabbitmqEventExchange => write!(f, "rabbitmq_event_exchange"),
Self::RabbitmqFederation => write!(f, "rabbitmq_federation"),
Self::RabbitmqFederationManagement => write!(f, "rabbitmq_federation_management"),
Self::RabbitmqFederationPrometheus => write!(f, "rabbitmq_federation_prometheus"),
Self::RabbitmqJmsTopicExchange => write!(f, "rabbitmq_jms_topic_exchange"),
Self::RabbitmqMqtt => write!(f, "rabbitmq_mqtt"),
Self::RabbitmqPeerDiscoveryAws => write!(f, "rabbitmq_peer_discovery_aws"),
Self::RabbitmqPeerDiscoveryCommon => write!(f, "rabbitmq_peer_discovery_common"),
Self::RabbitmqPeerDiscoveryConsul => write!(f, "rabbitmq_peer_discovery_consul"),
Self::RabbitmqPeerDiscoveryEtcd => write!(f, "rabbitmq_peer_discovery_etcd"),
Self::RabbitmqPeerDiscoveryK8s => write!(f, "rabbitmq_peer_discovery_k8s"),
Self::RabbitmqPrometheus => write!(f, "rabbitmq_prometheus"),
Self::RabbitmqRandomExchange => write!(f, "rabbitmq_random_exchange"),
Self::RabbitmqRecentHistoryExchange => write!(f, "rabbitmq_recent_history_exchange"),
Self::RabbitmqSharding => write!(f, "rabbitmq_sharding"),
Self::RabbitmqShovel => write!(f, "rabbitmq_shovel"),
Self::RabbitmqShovelManagement => write!(f, "rabbitmq_shovel_management"),
Self::RabbitmqShovelPrometheus => write!(f, "rabbitmq_shovel_prometheus"),
Self::RabbitmqStomp => write!(f, "rabbitmq_stomp"),
Self::RabbitmqStream => write!(f, "rabbitmq_stream"),
Self::RabbitmqStreamManagement => write!(f, "rabbitmq_stream_management"),
Self::RabbitmqTop => write!(f, "rabbitmq_top"),
Self::RabbitmqTracing => write!(f, "rabbitmq_tracing"),
Self::RabbitmqTrustStore => write!(f, "rabbitmq_trust_store"),
Self::RabbitmqWebMqtt => write!(f, "rabbitmq_web_mqtt"),
Self::RabbitmqWebStomp => write!(f, "rabbitmq_web_stomp")
}
}
}
impl Default for DbExtension {
fn default() -> DbExtension {
Self::PgStatStatements
}
}