OpenAPIClient-php

Введение

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	Опционально. В большинстве случаев в ответе будет содержаться уникальный идентификатор ответа в формате UUIDv4, который однозначно указывает на ваш запрос внутри нашей системы. Если вам потребуется задать вопрос нашей поддержке, приложите к вопросу этот идентификатор — так мы сможем найти ответ на него намного быстрее. Также вы можете использовать этот идентификатор, чтобы убедиться, что это новый ответ на запрос и результат не был получен из кэша.

Пример запроса на получение списка SSH-ключей:

    HTTP/2.0 200 OK
    {
      \"ssh_keys\":[
          {
            \"body\":\"ssh-rsa AAAAB3NzaC1sdfghjkOAsBwWhs= [email protected]\",
            \"created_at\":\"2021-09-15T19:52:27Z\",
            \"expired_at\":null,
            \"id\":5297,
            \"is_default\":false,
            \"name\":\"[email protected]\",
            \"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	Опционально. В большинстве случае в ответе будет содержаться уникальный идентификатор ответа в формате UUIDv4, который однозначно указывает на ваш запрос внутри нашей системы. Если вам потребуется задать вопрос нашей поддержке, приложите к вопросу этот идентификатор — так мы сможем найти ответ на него намного быстрее.

Пример:

    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 и идентификатором созданного ресурса в теле ответа, но при этом этот ресурс может быть ещё в состоянии запуска.

Для того чтобы понять, в каком состоянии сейчас находится ваш ресурс, мы добавили поле 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\"

После этого токен будет автоматически подставляться в ваши запросы.

Обратите внимание, что все значения в этой документации являются примерами. Не полагайтесь на идентификаторы операционных систем, тарифов и т.д., используемые в примерах. Используйте соответствующую конечную точку для получения значений перед созданием ресурсов.

Версионирование

API построено согласно принципам семантического версионирования. Это значит, что мы гарантируем обратную совместимость всех изменений в пределах одной мажорной версии.

Мажорная версия каждой конечной точки обозначается в пути запроса, например, запрос /api/v1/servers указывает, что этот метод имеет версию 1.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer (JWT) authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\APIKeysApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$create_api_key = new \OpenAPI\Client\Model\CreateApiKey(); // \OpenAPI\Client\Model\CreateApiKey

try {
    $result = $apiInstance->createToken($create_api_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling APIKeysApi->createToken: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.timeweb.cloud

Class	Method	HTTP request	Description
APIKeysApi	createToken	POST /api/v1/auth/api-keys	Создание токена
APIKeysApi	deleteToken	DELETE /api/v1/auth/api-keys/{token_id}	Удалить токен
APIKeysApi	getTokens	GET /api/v1/auth/api-keys	Получение списка выпущенных токенов
APIKeysApi	reissueToken	PUT /api/v1/auth/api-keys/{token_id}	Перевыпустить токен
APIKeysApi	updateToken	PATCH /api/v1/auth/api-keys/{token_id}	Изменить токен
AccountApi	addCountriesToAllowedList	POST /api/v1/auth/access/countries	Добавление стран в список разрешенных
AccountApi	addIPsToAllowedList	POST /api/v1/auth/access/ips	Добавление IP-адресов в список разрешенных
AccountApi	deleteCountriesFromAllowedList	DELETE /api/v1/auth/access/countries	Удаление стран из списка разрешенных
AccountApi	deleteIPsFromAllowedList	DELETE /api/v1/auth/access/ips	Удаление IP-адресов из списка разрешенных
AccountApi	getAccountStatus	GET /api/v1/account/status	Получение статуса аккаунта
AccountApi	getAuthAccessSettings	GET /api/v1/auth/access	Получить информацию о ограничениях авторизации пользователя
AccountApi	getCountries	GET /api/v1/auth/access/countries	Получение списка стран
AccountApi	getFinances	GET /api/v1/account/finances	Получение платежной информации
AccountApi	getNotificationSettings	GET /api/v1/account/notification-settings	Получение настроек уведомлений аккаунта
AccountApi	updateAuthRestrictionsByCountries	POST /api/v1/auth/access/countries/enabled	Включение/отключение ограничений по стране
AccountApi	updateAuthRestrictionsByIP	POST /api/v1/auth/access/ips/enabled	Включение/отключение ограничений по IP-адресу
AccountApi	updateNotificationSettings	PATCH /api/v1/account/notification-settings	Изменение настроек уведомлений аккаунта
BalancersApi	addIPsToBalancer	POST /api/v1/balancers/{balancer_id}/ips	Добавление IP-адресов к балансировщику
BalancersApi	createBalancer	POST /api/v1/balancers	Создание бaлансировщика
BalancersApi	createBalancerRule	POST /api/v1/balancers/{balancer_id}/rules	Создание правила для балансировщика
BalancersApi	deleteBalancer	DELETE /api/v1/balancers/{balancer_id}	Удаление балансировщика
BalancersApi	deleteBalancerRule	DELETE /api/v1/balancers/{balancer_id}/rules/{rule_id}	Удаление правила для балансировщика
BalancersApi	deleteIPsFromBalancer	DELETE /api/v1/balancers/{balancer_id}/ips	Удаление IP-адресов из балансировщика
BalancersApi	getBalancer	GET /api/v1/balancers/{balancer_id}	Получение бaлансировщика
BalancersApi	getBalancerIPs	GET /api/v1/balancers/{balancer_id}/ips	Получение списка IP-адресов балансировщика
BalancersApi	getBalancerRules	GET /api/v1/balancers/{balancer_id}/rules	Получение правил балансировщика
BalancersApi	getBalancers	GET /api/v1/balancers	Получение списка всех бaлансировщиков
BalancersApi	getBalancersPresets	GET /api/v1/presets/balancers	Получение списка тарифов для балансировщика
BalancersApi	updateBalancer	PATCH /api/v1/balancers/{balancer_id}	Обновление балансировщика
BalancersApi	updateBalancerRule	PATCH /api/v1/balancers/{balancer_id}/rules/{rule_id}	Обновление правила для балансировщика
DatabasesApi	createDatabase	POST /api/v1/dbs	Создание базы данных
DatabasesApi	createDatabaseBackup	POST /api/v1/dbs/{db_id}/backups	Создание бэкапа базы данных
DatabasesApi	createDatabaseCluster	POST /api/v1/databases	Создание кластера базы данных
DatabasesApi	createDatabaseInstance	POST /api/v1/databases/{db_cluster_id}/instances	Создание инстанса базы данных
DatabasesApi	createDatabaseUser	POST /api/v1/databases/{db_cluster_id}/admins	Создание пользователя базы данных
DatabasesApi	deleteDatabase	DELETE /api/v1/dbs/{db_id}	Удаление базы данных
DatabasesApi	deleteDatabaseBackup	DELETE /api/v1/dbs/{db_id}/backups/{backup_id}	Удаление бэкапа базы данных
DatabasesApi	deleteDatabaseCluster	DELETE /api/v1/databases/{db_cluster_id}	Удаление кластера базы данных
DatabasesApi	deleteDatabaseInstance	DELETE /api/v1/databases/{db_cluster_id}/instances/{instance_id}	Удаление инстанса базы данных
DatabasesApi	deleteDatabaseUser	DELETE /api/v1/databases/{db_cluster_id}/admins/{admin_id}	Удаление пользователя базы данных
DatabasesApi	getDatabase	GET /api/v1/dbs/{db_id}	Получение базы данных
DatabasesApi	getDatabaseAutoBackupsSettings	GET /api/v1/dbs/{db_id}/auto-backups	Получение настроек автобэкапов базы данных
DatabasesApi	getDatabaseBackup	GET /api/v1/dbs/{db_id}/backups/{backup_id}	Получение бэкапа базы данных
DatabasesApi	getDatabaseBackups	GET /api/v1/dbs/{db_id}/backups	Список бэкапов базы данных
DatabasesApi	getDatabaseCluster	GET /api/v1/databases/{db_cluster_id}	Получение кластера базы данных
DatabasesApi	getDatabaseClusters	GET /api/v1/databases	Получение списка кластеров баз данных
DatabasesApi	getDatabaseInstance	GET /api/v1/databases/{db_cluster_id}/instances/{instance_id}	Получение инстанса базы данных
DatabasesApi	getDatabaseInstances	GET /api/v1/databases/{db_cluster_id}/instances	Получение списка инстансов баз данных
DatabasesApi	getDatabaseUser	GET /api/v1/databases/{db_cluster_id}/admins/{admin_id}	Получение пользователя базы данных
DatabasesApi	getDatabaseUsers	GET /api/v1/databases/{db_cluster_id}/admins	Получение списка пользователей базы данных
DatabasesApi	getDatabases	GET /api/v1/dbs	Получение списка всех баз данных
DatabasesApi	getDatabasesPresets	GET /api/v1/presets/dbs	Получение списка тарифов для баз данных
DatabasesApi	restoreDatabaseFromBackup	PUT /api/v1/dbs/{db_id}/backups/{backup_id}	Восстановление базы данных из бэкапа
DatabasesApi	updateDatabase	PATCH /api/v1/dbs/{db_id}	Обновление базы данных
DatabasesApi	updateDatabaseAutoBackupsSettings	PATCH /api/v1/dbs/{db_id}/auto-backups	Изменение настроек автобэкапов базы данных
DatabasesApi	updateDatabaseCluster	PATCH /api/v1/databases/{db_cluster_id}	Изменение кластера базы данных
DatabasesApi	updateDatabaseInstance	PATCH /api/v1/databases/{db_cluster_id}/instances/{instance_id}	Изменение инстанса базы данных
DatabasesApi	updateDatabaseUser	PATCH /api/v1/databases/{db_cluster_id}/admins/{admin_id}	Изменение пользователя базы данных
DedicatedServersApi	createDedicatedServer	POST /api/v1/dedicated-servers	Создание выделенного сервера
DedicatedServersApi	deleteDedicatedServer	DELETE /api/v1/dedicated-servers/{dedicated_id}	Удаление выделенного сервера
DedicatedServersApi	getDedicatedServer	GET /api/v1/dedicated-servers/{dedicated_id}	Получение выделенного сервера
DedicatedServersApi	getDedicatedServerPresetAdditionalServices	GET /api/v1/presets/dedicated-servers/{preset_id}/additional-services	Получение дополнительных услуг для выделенного сервера
DedicatedServersApi	getDedicatedServers	GET /api/v1/dedicated-servers	Получение списка выделенных серверов
DedicatedServersApi	getDedicatedServersPresets	GET /api/v1/presets/dedicated-servers	Получение списка тарифов для выделенного сервера
DedicatedServersApi	updateDedicatedServer	PATCH /api/v1/dedicated-servers/{dedicated_id}	Обновление выделенного сервера
DomainsApi	addDomain	POST /api/v1/add-domain/{fqdn}	Добавление домена на аккаунт
DomainsApi	addSubdomain	POST /api/v1/domains/{fqdn}/subdomains/{subdomain_fqdn}	Добавление поддомена
DomainsApi	checkDomain	GET /api/v1/check-domain/{fqdn}	Проверить, доступен ли домен для регистрации
DomainsApi	createDomainDNSRecord	POST /api/v1/domains/{fqdn}/dns-records	Добавить информацию о DNS-записи для домена или поддомена
DomainsApi	createDomainRequest	POST /api/v1/domains-requests	Создание заявки на регистрацию/продление/трансфер домена
DomainsApi	deleteDomain	DELETE /api/v1/domains/{fqdn}	Удаление домена
DomainsApi	deleteDomainDNSRecord	DELETE /api/v1/domains/{fqdn}/dns-records/{record_id}	Удалить информацию о DNS-записи для домена или поддомена
DomainsApi	deleteSubdomain	DELETE /api/v1/domains/{fqdn}/subdomains/{subdomain_fqdn}	Удаление поддомена
DomainsApi	getDomain	GET /api/v1/domains/{fqdn}	Получение информации о домене
DomainsApi	getDomainDNSRecords	GET /api/v1/domains/{fqdn}/dns-records	Получить информацию обо всех пользовательских DNS-записях домена или поддомена
DomainsApi	getDomainDefaultDNSRecords	GET /api/v1/domains/{fqdn}/default-dns-records	Получить информацию обо всех DNS-записях по умолчанию домена или поддомена
DomainsApi	getDomainNameServers	GET /api/v1/domains/{fqdn}/name-servers	Получение списка name-серверов домена
DomainsApi	getDomainRequest	GET /api/v1/domains-requests/{request_id}	Получение заявки на регистрацию/продление/трансфер домена
DomainsApi	getDomainRequests	GET /api/v1/domains-requests	Получение списка заявок на регистрацию/продление/трансфер домена
DomainsApi	getDomains	GET /api/v1/domains	Получение списка всех доменов
DomainsApi	getTLD	GET /api/v1/tlds/{tld_id}	Получить информацию о доменной зоне по идентификатору
DomainsApi	getTLDs	GET /api/v1/tlds	Получить информацию о доменных зонах
DomainsApi	updateDomainAutoProlongation	PATCH /api/v1/domains/{fqdn}	Включение/выключение автопродления домена
DomainsApi	updateDomainDNSRecord	PATCH /api/v1/domains/{fqdn}/dns-records/{record_id}	Обновить информацию о DNS-записи домена или поддомена
DomainsApi	updateDomainNameServers	PUT /api/v1/domains/{fqdn}/name-servers	Изменение name-серверов домена
DomainsApi	updateDomainRequest	PATCH /api/v1/domains-requests/{request_id}	Оплата/обновление заявки на регистрацию/продление/трансфер домена
FirewallApi	addResourceToGroup	POST /api/v1/firewall/groups/{group_id}/resources/{resource_id}	Линковка ресурса в firewall group
FirewallApi	createGroup	POST /api/v1/firewall/groups	Создание группы правил
FirewallApi	createGroupRule	POST /api/v1/firewall/groups/{group_id}/rules	Создание firewall правила
FirewallApi	deleteGroup	DELETE /api/v1/firewall/groups/{group_id}	Удаление группы правил
FirewallApi	deleteGroupRule	DELETE /api/v1/firewall/groups/{group_id}/rules/{rule_id}	Удаление firewall правила
FirewallApi	deleteResourceFromGroup	DELETE /api/v1/firewall/groups/{group_id}/resources/{resource_id}	Отлинковка ресурса из firewall group
FirewallApi	getGroup	GET /api/v1/firewall/groups/{group_id}	Получение информации о группе правил
FirewallApi	getGroupResources	GET /api/v1/firewall/groups/{group_id}/resources	Получение слинкованных ресурсов
FirewallApi	getGroupRule	GET /api/v1/firewall/groups/{group_id}/rules/{rule_id}	Получение информации о правиле
FirewallApi	getGroupRules	GET /api/v1/firewall/groups/{group_id}/rules	Получение списка правил
FirewallApi	getGroups	GET /api/v1/firewall/groups	Получение групп правил
FirewallApi	getRulesForResource	GET /api/v1/firewall/service/{resource_type}/{resource_id}	Получение групп правил для ресурса
FirewallApi	updateGroup	PATCH /api/v1/firewall/groups/{group_id}	Обновление группы правил
FirewallApi	updateGroupRule	PATCH /api/v1/firewall/groups/{group_id}/rules/{rule_id}	Обновление firewall правила
ImagesApi	createImage	POST /api/v1/images	Создание образа
ImagesApi	createImageDownloadUrl	POST /api/v1/images/{image_id}/download-url	Создание ссылки на скачивание образа
ImagesApi	deleteImage	DELETE /api/v1/images/{image_id}	Удаление образа
ImagesApi	deleteImageDownloadURL	DELETE /api/v1/images/{image_id}/download-url/{image_url_id}	Удаление ссылки на образ
ImagesApi	getImage	GET /api/v1/images/{image_id}	Получение информации о образе
ImagesApi	getImageDownloadURL	GET /api/v1/images/{image_id}/download-url/{image_url_id}	Получение информации о ссылке на скачивание образа
ImagesApi	getImageDownloadURLs	GET /api/v1/images/{image_id}/download-url	Получение информации о ссылках на скачивание образов
ImagesApi	getImages	GET /api/v1/images	Получение списка образов
ImagesApi	updateImage	PATCH /api/v1/images/{image_id}	Обновление информации о образе
ImagesApi	uploadImage	POST /api/v1/images/{image_id}	Загрузка образа
KubernetesApi	createCluster	POST /api/v1/k8s/clusters	Создание кластера
KubernetesApi	createClusterNodeGroup	POST /api/v1/k8s/clusters/{cluster_id}/groups	Создание группы нод
KubernetesApi	deleteCluster	DELETE /api/v1/k8s/clusters/{cluster_id}	Удаление кластера
KubernetesApi	deleteClusterNode	DELETE /api/v1/k8s/clusters/{cluster_id}/nodes/{node_id}	Удаление ноды
KubernetesApi	deleteClusterNodeGroup	DELETE /api/v1/k8s/clusters/{cluster_id}/groups/{group_id}	Удаление группы нод
KubernetesApi	getCluster	GET /api/v1/k8s/clusters/{cluster_id}	Получение информации о кластере
KubernetesApi	getClusterKubeconfig	GET /api/v1/k8s/clusters/{cluster_id}/kubeconfig	Получение файла kubeconfig
KubernetesApi	getClusterNodeGroup	GET /api/v1/k8s/clusters/{cluster_id}/groups/{group_id}	Получение информации о группе нод
KubernetesApi	getClusterNodeGroups	GET /api/v1/k8s/clusters/{cluster_id}/groups	Получение групп нод кластера
KubernetesApi	getClusterNodes	GET /api/v1/k8s/clusters/{cluster_id}/nodes	Получение списка нод
KubernetesApi	getClusterNodesFromGroup	GET /api/v1/k8s/clusters/{cluster_id}/groups/{group_id}/nodes	Получение списка нод, принадлежащих группе
KubernetesApi	getClusterResources	GET /api/v1/k8s/clusters/{cluster_id}/resources	Получение ресурсов кластера
KubernetesApi	getClusters	GET /api/v1/k8s/clusters	Получение списка кластеров
KubernetesApi	getK8SNetworkDrivers	GET /api/v1/k8s/network_drivers	Получение списка сетевых драйверов k8s
KubernetesApi	getK8SVersions	GET /api/v1/k8s/k8s_versions	Получение списка версий k8s
KubernetesApi	getKubernetesPresets	GET /api/v1/presets/k8s	Получение списка тарифов
KubernetesApi	increaseCountOfNodesInGroup	POST /api/v1/k8s/clusters/{cluster_id}/groups/{group_id}/nodes	Увеличение количества нод в группе на указанное количество
KubernetesApi	reduceCountOfNodesInGroup	DELETE /api/v1/k8s/clusters/{cluster_id}/groups/{group_id}/nodes	Уменьшение количества нод в группе на указанное количество
KubernetesApi	updateCluster	PATCH /api/v1/k8s/clusters/{cluster_id}	Обновление информации о кластере
MailApi	createDomainMailbox	POST /api/v1/mail/domains/{domain}	Создание почтового ящика
MailApi	deleteMailbox	DELETE /api/v1/mail/domains/{domain}/mailboxes/{mailbox}	Удаление почтового ящика
MailApi	getDomainMailInfo	GET /api/v1/mail/domains/{domain}/info	Получение почтовой информации о домене
MailApi	getDomainMailboxes	GET /api/v1/mail/domains/{domain}	Получение списка почтовых ящиков домена
MailApi	getMailQuota	GET /api/v1/mail/quota	Получение квоты почты аккаунта
MailApi	getMailbox	GET /api/v1/mail/domains/{domain}/mailboxes/{mailbox}	Получение почтового ящика
MailApi	getMailboxes	GET /api/v1/mail	Получение списка почтовых ящиков аккаунта
MailApi	updateDomainMailInfo	PATCH /api/v1/mail/domains/{domain}/info	Изменение почтовой информации о домене
MailApi	updateMailQuota	PATCH /api/v1/mail/quota	Изменение квоты почты аккаунта
MailApi	updateMailbox	PATCH /api/v1/mail/domains/{domain}/mailboxes/{mailbox}	Изменение почтового ящика
ProjectsApi	addBalancerToProject	POST /api/v1/projects/{project_id}/resources/balancers	Добавление балансировщика в проект
ProjectsApi	addClusterToProject	POST /api/v1/projects/{project_id}/resources/clusters	Добавление кластера в проект
ProjectsApi	addDatabaseToProject	POST /api/v1/projects/{project_id}/resources/databases	Добавление базы данных в проект
ProjectsApi	addDedicatedServerToProject	POST /api/v1/projects/{project_id}/resources/dedicated	Добавление выделенного сервера в проект
ProjectsApi	addServerToProject	POST /api/v1/projects/{project_id}/resources/servers	Добавление сервера в проект
ProjectsApi	addStorageToProject	POST /api/v1/projects/{project_id}/resources/buckets	Добавление хранилища в проект
ProjectsApi	createProject	POST /api/v1/projects	Создание проекта
ProjectsApi	deleteProject	DELETE /api/v1/projects/{project_id}	Удаление проекта
ProjectsApi	getAccountBalancers	GET /api/v1/projects/resources/balancers	Получение списка всех балансировщиков на аккаунте
ProjectsApi	getAccountClusters	GET /api/v1/projects/resources/clusters	Получение списка всех кластеров на аккаунте
ProjectsApi	getAccountDatabases	GET /api/v1/projects/resources/databases	Получение списка всех баз данных на аккаунте
ProjectsApi	getAccountDedicatedServers	GET /api/v1/projects/resources/dedicated	Получение списка всех выделенных серверов на аккаунте
ProjectsApi	getAccountServers	GET /api/v1/projects/resources/servers	Получение списка всех серверов на аккаунте
ProjectsApi	getAccountStorages	GET /api/v1/projects/resources/buckets	Получение списка всех хранилищ на аккаунте
ProjectsApi	getAllProjectResources	GET /api/v1/projects/{project_id}/resources	Получение всех ресурсов проекта
ProjectsApi	getProject	GET /api/v1/projects/{project_id}	Получение проекта по идентификатору
ProjectsApi	getProjectBalancers	GET /api/v1/projects/{project_id}/resources/balancers	Получение списка балансировщиков проекта
ProjectsApi	getProjectClusters	GET /api/v1/projects/{project_id}/resources/clusters	Получение списка кластеров проекта
ProjectsApi	getProjectDatabases	GET /api/v1/projects/{project_id}/resources/databases	Получение списка баз данных проекта
ProjectsApi	getProjectDedicatedServers	GET /api/v1/projects/{project_id}/resources/dedicated	Получение списка выделенных серверов проекта
ProjectsApi	getProjectServers	GET /api/v1/projects/{project_id}/resources/servers	Получение списка серверов проекта
ProjectsApi	getProjectStorages	GET /api/v1/projects/{project_id}/resources/buckets	Получение списка хранилищ проекта
ProjectsApi	getProjects	GET /api/v1/projects	Получение списка проектов
ProjectsApi	transferResourceToAnotherProject	PUT /api/v1/projects/{project_id}/resources/transfer	Перенести ресурс в другой проект
ProjectsApi	updateProject	PUT /api/v1/projects/{project_id}	Изменение проекта
S3Api	addStorageSubdomainCertificate	POST /api/v1/storages/certificates/generate	Добавление сертификата для поддомена хранилища
S3Api	addStorageSubdomains	POST /api/v1/storages/buckets/{bucket_id}/subdomains	Добавление поддоменов для хранилища
S3Api	copyStorageFile	POST /api/v1/storages/buckets/{bucket_id}/object-manager/copy	Копирование файла/директории в хранилище
S3Api	createFolderInStorage	POST /api/v1/storages/buckets/{bucket_id}/object-manager/mkdir	Создание директории в хранилище
S3Api	createStorage	POST /api/v1/storages/buckets	Создание хранилища
S3Api	deleteStorage	DELETE /api/v1/storages/buckets/{bucket_id}	Удаление хранилища на аккаунте
S3Api	deleteStorageFile	DELETE /api/v1/storages/buckets/{bucket_id}/object-manager/remove	Удаление файла/директории в хранилище
S3Api	deleteStorageSubdomains	DELETE /api/v1/storages/buckets/{bucket_id}/subdomains	Удаление поддоменов хранилища
S3Api	getStorageFilesList	GET /api/v1/storages/buckets/{bucket_id}/object-manager/list	Получение списка файлов в хранилище по префиксу
S3Api	getStorageSubdomains	GET /api/v1/storages/buckets/{bucket_id}/subdomains	Получение списка поддоменов хранилища
S3Api	getStorageTransferStatus	GET /api/v1/storages/buckets/{bucket_id}/transfer-status	Получение статуса переноса хранилища от стороннего S3 в Timeweb Cloud
S3Api	getStorageUsers	GET /api/v1/storages/users	Получение списка пользователей хранилищ аккаунта
S3Api	getStorages	GET /api/v1/storages/buckets	Получение списка хранилищ аккаунта
S3Api	getStoragesPresets	GET /api/v1/presets/storages	Получение списка тарифов для хранилищ
S3Api	renameStorageFile	POST /api/v1/storages/buckets/{bucket_id}/object-manager/rename	Переименование файла/директории в хранилище
S3Api	transferStorage	POST /api/v1/storages/transfer	Перенос хранилища от стороннего провайдера S3 в Timeweb Cloud
S3Api	updateStorage	PATCH /api/v1/storages/buckets/{bucket_id}	Изменение хранилища на аккаунте
S3Api	updateStorageUser	PATCH /api/v1/storages/users/{user_id}	Изменение пароля пользователя-администратора хранилища
S3Api	uploadFileToStorage	POST /api/v1/storages/buckets/{bucket_id}/object-manager/upload	Загрузка файлов в хранилище
SSHApi	addKeyToServer	POST /api/v1/servers/{server_id}/ssh-keys	Добавление SSH-ключей на сервер
SSHApi	createKey	POST /api/v1/ssh-keys	Создание SSH-ключа
SSHApi	deleteKey	DELETE /api/v1/ssh-keys/{ssh_key_id}	Удаление SSH-ключа по уникальному идентификатору
SSHApi	deleteKeyFromServer	DELETE /api/v1/servers/{server_id}/ssh-keys/{ssh_key_id}	Удаление SSH-ключей с сервера
SSHApi	getKey	GET /api/v1/ssh-keys/{ssh_key_id}	Получение SSH-ключа по уникальному идентификатору
SSHApi	getKeys	GET /api/v1/ssh-keys	Получение списка SSH-ключей
SSHApi	updateKey	PATCH /api/v1/ssh-keys/{ssh_key_id}	Изменение SSH-ключа по уникальному идентификатору
ServersApi	addServerIP	POST /api/v1/servers/{server_id}/ips	Добавление IP-адреса сервера
ServersApi	cloneServer	POST /api/v1/servers/{server_id}/clone	Клонирование сервера
ServersApi	createServer	POST /api/v1/servers	Создание сервера
ServersApi	createServerDisk	POST /api/v1/servers/{server_id}/disks	Создание диска сервера
ServersApi	createServerDiskBackup	POST /api/v1/servers/{server_id}/disks/{disk_id}/backups	Создание бэкапа диска сервера
ServersApi	deleteServer	DELETE /api/v1/servers/{server_id}	Удаление сервера
ServersApi	deleteServerDisk	DELETE /api/v1/servers/{server_id}/disks/{disk_id}	Удаление диска сервера
ServersApi	deleteServerDiskBackup	DELETE /api/v1/servers/{server_id}/disks/{disk_id}/backups/{backup_id}	Удаление бэкапа диска сервера
ServersApi	deleteServerIP	DELETE /api/v1/servers/{server_id}/ips	Удаление IP-адреса сервера
ServersApi	getConfigurators	GET /api/v1/configurator/servers	Получение списка конфигураторов серверов
ServersApi	getOsList	GET /api/v1/os/servers	Получение списка операционных систем
ServersApi	getServer	GET /api/v1/servers/{server_id}	Получение сервера
ServersApi	getServerDisk	GET /api/v1/servers/{server_id}/disks/{disk_id}	Получение диска сервера
ServersApi	getServerDiskAutoBackupSettings	GET /api/v1/servers/{server_id}/disks/{disk_id}/auto-backups	Получить настройки автобэкапов диска сервера
ServersApi	getServerDiskBackup	GET /api/v1/servers/{server_id}/disks/{disk_id}/backups/{backup_id}	Получение бэкапа диска сервера
ServersApi	getServerDiskBackups	GET /api/v1/servers/{server_id}/disks/{disk_id}/backups	Получение списка бэкапов диска сервера
ServersApi	getServerDisks	GET /api/v1/servers/{server_id}/disks	Получение списка дисков сервера
ServersApi	getServerIPs	GET /api/v1/servers/{server_id}/ips	Получение списка IP-адресов сервера
ServersApi	getServerLogs	GET /api/v1/servers/{server_id}/logs	Получение списка логов сервера
ServersApi	getServerStatistics	GET /api/v1/servers/{server_id}/statistics	Получение статистики сервера
ServersApi	getServers	GET /api/v1/servers	Получение списка серверов
ServersApi	getServersPresets	GET /api/v1/presets/servers	Получение списка тарифов серверов
ServersApi	getSoftware	GET /api/v1/software/servers	Получение списка ПО из маркетплейса
ServersApi	imageUnmountAndServerReload	POST /api/v1/servers/{server_id}/image-unmount	Отмонтирование ISO образа и перезагрузка сервера
ServersApi	performActionOnBackup	POST /api/v1/servers/{server_id}/disks/{disk_id}/backups/{backup_id}/action	Выполнение действия над бэкапом диска сервера
ServersApi	performActionOnServer	POST /api/v1/servers/{server_id}/action	Выполнение действия над сервером
ServersApi	updateServer	PATCH /api/v1/servers/{server_id}	Изменение сервера
ServersApi	updateServerDisk	PATCH /api/v1/servers/{server_id}/disks/{disk_id}	Изменение параметров диска сервера
ServersApi	updateServerDiskAutoBackupSettings	PATCH /api/v1/servers/{server_id}/disks/{disk_id}/auto-backups	Изменение настроек автобэкапов диска сервера
ServersApi	updateServerDiskBackup	PATCH /api/v1/servers/{server_id}/disks/{disk_id}/backups/{backup_id}	Изменение бэкапа диска сервера
ServersApi	updateServerIP	PATCH /api/v1/servers/{server_id}/ips	Изменение IP-адреса сервера
ServersApi	updateServerNAT	PATCH /api/v1/servers/{server_id}/local-networks/nat-mode	Изменение правил маршрутизации трафика сервера (NAT)
ServersApi	updateServerOSBootMode	POST /api/v1/servers/{server_id}/boot-mode	Выбор типа загрузки операционной системы сервера
VPCApi	createVPC	POST /api/v2/vpcs	Создание VPC
VPCApi	deleteVPC	DELETE /api/v1/vpcs/{vpc_id}	Удаление VPC по идентификатору сети
VPCApi	getVPC	GET /api/v2/vpcs/{vpc_id}	Получение VPC
VPCApi	getVPCPorts	GET /api/v1/vpcs/{vpc_id}/ports	Получение списка портов для VPC
VPCApi	getVPCServices	GET /api/v2/vpcs/{vpc_id}/services	Получение списка сервисов в VPC
VPCApi	getVPCs	GET /api/v2/vpcs	Получение списка VPCs
VPCApi	updateVPCs	PATCH /api/v2/vpcs/{vpc_id}	Изменение VPC по идентификатору сети

Models

Authorization

Authentication schemes defined for the API:

Bearer

Type: Bearer authentication (JWT)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

[email protected]

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

oberlin2002 / timeweb-sdk-php Goto Github PK

timeweb-sdk-php's Introduction