/* tslint:disable */ /* eslint-disable */ /** * Timeweb Cloud 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 * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { exists, mapValues } from '../runtime'; import type { DomainAllowedBuyPeriodsInner } from './DomainAllowedBuyPeriodsInner'; import { DomainAllowedBuyPeriodsInnerFromJSON, DomainAllowedBuyPeriodsInnerFromJSONTyped, DomainAllowedBuyPeriodsInnerToJSON, } from './DomainAllowedBuyPeriodsInner'; import type { Subdomain } from './Subdomain'; import { SubdomainFromJSON, SubdomainFromJSONTyped, SubdomainToJSON, } from './Subdomain'; /** * Домен * @export * @interface Domain */ export interface Domain { /** * Допустимые периоды продления домена. * @type {Array} * @memberof Domain */ allowedBuyPeriods: Array; /** * Количество дней, оставшихся до конца срока регистрации домена. * @type {number} * @memberof Domain */ daysLeft: number; /** * Статус домена. * @type {string} * @memberof Domain */ domainStatus: DomainDomainStatusEnum; /** * Дата окончания срока регистрации домена, для доменов без срока окончания регистрации будет приходить 0000-00-00. * @type {string} * @memberof Domain */ expiration: string; /** * Полное имя домена. * @type {string} * @memberof Domain */ fqdn: string; /** * ID домена. * @type {number} * @memberof Domain */ id: number; /** * Ссылка на аватар домена. * @type {string} * @memberof Domain */ avatarLink: string | null; /** * Это логическое значение, которое показывает, включено ли автопродление домена. * @type {boolean} * @memberof Domain */ isAutoprolongEnabled: boolean | null; /** * Это логическое значение, которое показывает, является ли домен премиальным. * @type {boolean} * @memberof Domain */ isPremium: boolean; /** * Это логическое значение, которое показывает, можно ли сейчас продлить домен. * @type {boolean} * @memberof Domain */ isProlongAllowed: boolean; /** * Это логическое значение, которое показывает, является ли домен техническим. * @type {boolean} * @memberof Domain */ isTechnical: boolean; /** * Это логическое значение, которое показывает, включено ли скрытие данных администратора домена для whois. Если приходит null, значит для данной зоны эта услуга не доступна. * @type {boolean} * @memberof Domain */ isWhoisPrivacyEnabled: boolean | null; /** * Привязанный к домену IP-адрес. * @type {string} * @memberof Domain */ linkedIp: string | null; /** * До какого числа оплачен домен. * @type {string} * @memberof Domain */ paidTill: string | null; /** * ID администратора, на которого зарегистрирован домен. * @type {number} * @memberof Domain */ personId: number | null; /** * Стоимость премиального домена. * @type {number} * @memberof Domain */ premiumProlongCost: number | null; /** * ID регистратора домена. * @type {string} * @memberof Domain */ provider: string | null; /** * Статус заявки на продление/регистрацию/трансфер домена. * @type {string} * @memberof Domain */ requestStatus: DomainRequestStatusEnum; /** * Список поддоменов. * @type {Array} * @memberof Domain */ subdomains: Array; /** * ID доменной зоны. * @type {number} * @memberof Domain */ tldId: number | null; } /** * @export */ export const DomainDomainStatusEnum = { AwaitingPayment: 'awaiting_payment', Expired: 'expired', FinalExpired: 'final_expired', Free: 'free', NoPaid: 'no_paid', NsBased: 'ns_based', Paid: 'paid', SoonExpire: 'soon_expire', TodayExpired: 'today_expired' } as const; export type DomainDomainStatusEnum = typeof DomainDomainStatusEnum[keyof typeof DomainDomainStatusEnum]; /** * @export */ export const DomainRequestStatusEnum = { ProlongationFail: 'prolongation_fail', ProlongationRequest: 'prolongation_request', RegistrationFail: 'registration_fail', RegistrationRequest: 'registration_request', TransferFail: 'transfer_fail', TransferRequest: 'transfer_request', AwaitingPerson: 'awaiting_person' } as const; export type DomainRequestStatusEnum = typeof DomainRequestStatusEnum[keyof typeof DomainRequestStatusEnum]; /** * Check if a given object implements the Domain interface. */ export function instanceOfDomain(value: object): boolean { let isInstance = true; isInstance = isInstance && "allowedBuyPeriods" in value; isInstance = isInstance && "daysLeft" in value; isInstance = isInstance && "domainStatus" in value; isInstance = isInstance && "expiration" in value; isInstance = isInstance && "fqdn" in value; isInstance = isInstance && "id" in value; isInstance = isInstance && "avatarLink" in value; isInstance = isInstance && "isAutoprolongEnabled" in value; isInstance = isInstance && "isPremium" in value; isInstance = isInstance && "isProlongAllowed" in value; isInstance = isInstance && "isTechnical" in value; isInstance = isInstance && "isWhoisPrivacyEnabled" in value; isInstance = isInstance && "linkedIp" in value; isInstance = isInstance && "paidTill" in value; isInstance = isInstance && "personId" in value; isInstance = isInstance && "premiumProlongCost" in value; isInstance = isInstance && "provider" in value; isInstance = isInstance && "requestStatus" in value; isInstance = isInstance && "subdomains" in value; isInstance = isInstance && "tldId" in value; return isInstance; } export function DomainFromJSON(json: any): Domain { return DomainFromJSONTyped(json, false); } export function DomainFromJSONTyped(json: any, ignoreDiscriminator: boolean): Domain { if ((json === undefined) || (json === null)) { return json; } return { 'allowedBuyPeriods': ((json['allowed_buy_periods'] as Array).map(DomainAllowedBuyPeriodsInnerFromJSON)), 'daysLeft': json['days_left'], 'domainStatus': json['domain_status'], 'expiration': json['expiration'], 'fqdn': json['fqdn'], 'id': json['id'], 'avatarLink': json['avatar_link'], 'isAutoprolongEnabled': json['is_autoprolong_enabled'], 'isPremium': json['is_premium'], 'isProlongAllowed': json['is_prolong_allowed'], 'isTechnical': json['is_technical'], 'isWhoisPrivacyEnabled': json['is_whois_privacy_enabled'], 'linkedIp': json['linked_ip'], 'paidTill': json['paid_till'], 'personId': json['person_id'], 'premiumProlongCost': json['premium_prolong_cost'], 'provider': json['provider'], 'requestStatus': json['request_status'], 'subdomains': ((json['subdomains'] as Array).map(SubdomainFromJSON)), 'tldId': json['tld_id'], }; } export function DomainToJSON(value?: Domain | null): any { if (value === undefined) { return undefined; } if (value === null) { return null; } return { 'allowed_buy_periods': ((value.allowedBuyPeriods as Array).map(DomainAllowedBuyPeriodsInnerToJSON)), 'days_left': value.daysLeft, 'domain_status': value.domainStatus, 'expiration': value.expiration, 'fqdn': value.fqdn, 'id': value.id, 'avatar_link': value.avatarLink, 'is_autoprolong_enabled': value.isAutoprolongEnabled, 'is_premium': value.isPremium, 'is_prolong_allowed': value.isProlongAllowed, 'is_technical': value.isTechnical, 'is_whois_privacy_enabled': value.isWhoisPrivacyEnabled, 'linked_ip': value.linkedIp, 'paid_till': value.paidTill, 'person_id': value.personId, 'premium_prolong_cost': value.premiumProlongCost, 'provider': value.provider, 'request_status': value.requestStatus, 'subdomains': ((value.subdomains as Array).map(SubdomainToJSON)), 'tld_id': value.tldId, }; }