База знаний

Изменения в Public API

Для пользователей, работающих с CLO с помощью публичного API, мы подготовили ряд масштабных изменений и улучшений, делающих работу с сервисом через HTTP-запросы ещё более удобной и надёжной.

Общие изменения

  • добавлены новые эндпоинты, расширяющие возможности работы через Public API
  • URL и коды ответа приведены к стандарту RESTful, либо в соответствие с документацией
  • в документацию добавлены недостающие описания для всех параметров эндпоинтов
  • в каждый эндпоинт, возвращающий детальную информацию либо список дочерних проекта сущностей, добавлен параметр project, содержащий уникальный идентификатор проекта
  • улучшена валидация входящих параметров запросов

Новые эндпоинты Public API

GET /v2/projects/{object_id}/detail — возвращает информацию о конкретном проекте
GET /v2/projects/{object_id}/servers/related-resources — возвращает список зависимостей между количеством vCPU и RAM сервера
GET /v2/projects/{object_id}/dbaas/related-resources — возвращает список зависимых параметров для кластера баз данных
GET /v2/dbaas/clusters/{object_id}/configuration — возвращает список действующих значений параметров конфигурации СУБД кластера
GET /v2/projects/{object_id}/dbaas/databases — возвращает список баз данных на конкретном проекте (не кластере)
POST /v2/addresses/{object_id}/bandwidth — изменяет ширину канала (100Мб - Гб) внешнего адреса, подключенного к серверу
PATCH /v2/servers/{object_id} — изменяет имя сервера
PATCH /v2/volumes/{object_id} — изменяет имя и/или описание диска

Изменения в документации

Раздел «Проект»

GET /v2/projects — добавлен параметр created_in

Раздел «Внешние IP-адреса»

POST /v2/addresses/{object_id}/attach — добавлено описание параметра запроса bandwidth_max_mbps
GET /v2/projects/{object_id}/addresses — добавлено описание параметров ответа, в которых содержится информация о сущности, к которой подключен IP-адрес
GET /v2/addresses/{object_id}/detail — добавлено описание параметров ответа, содержащих информацию об элементе инфраструктуры, к которому подключен IP-адрес

Раздел «Серверы»

POST /v2/projects/{object_id}/servers — был удален неактуальный параметр, добавлен параметр запроса bandwidth_max_mbps, добавлено описание параметра cpu_type
GET /v2/servers/{object_id}/detail — добавлены описания параметров recipe.status и project
GET /v2/projects/{object_id}/servers — добавлены описания параметров recipe.status и project

Раздел «Облачные базы данных»

DELETE /v2/dbaas/backups/{object_id} — добавлено описание параметра запроса force
POST /v2/projects/{object_id}/dbaas/clusters — добавлены описания для параметров запроса 
GET /v2/dbaas/backups/{object_id} — добавлено описание параметра project
GET /v2/dbaas/clusters/{object_id}/databases — добавлено описание параметра project
GET /v2/dbaas/clusters/{object_id} — добавлено описание параметра project
GET /v2/dbaas/clusters/{object_id}/nodes — добавлено описание параметра project
GET /v2/dbaas/databases/{object_id} — добавлено описание параметра project
GET /v2/projects/{object_id}/dbaas/backups — добавлено описание параметра project
GET /v2/projects/{object_id}/dbaas/clusters — добавлено описание параметра project

Раздел «Диски»

DELETE /v2/volumes/{object_id} — добавлены описания необязательных параметров запроса clear_fstab и force
POST /v2/volumes/{object_id}/detach — добавлен необязательный параметр запроса clear_fstab

Раздел «SSH-ключи»

GET /v2/keypairs/{object_id}/detail — добавлено описание параметра ответа created_in
POST /v2/projects/{object_id}/keypairs/generate — добавлено описание параметра ответа created_in
GET /v2/projects/{object_id}/keypairs — добавлено описание параметра ответа created_in
POST /v2/projects/{object_id}/keypairs — добавлено описание параметра ответа created_in

Раздел «Балансировщики нагрузки»

POST /v2/loadbalancers/{object_id}/rules — параметр port_id заменен на address_id 
POST /v2/projects/{object_id}/loadbalancers — добавлены описания параметров запроса IP-адреса

Раздел «Объектное хранилище S3»

GET /v2/projects/{object_id}/s3/users — добавлено описание параметра project
GET /v2/s3/users/{object_id}/detail — добавлено описание параметра project

Раздел «Виртуальные роутеры»

GET /v2/projects/{object_id}/vrouters — добавлено описание параметра project
GET /v2/vrouters/{object_id} — добавлено описание параметра project

Изменения в функциональной части Public API

Раздел «Серверы»

POST /v2/projects/{object_id} — код успешного ответа изменён на на 201
POST /v2/servers/{object_id}/stop — код успешного ответа изменён на на 202
POST /v2/servers/{object_id}/start — код успешного ответа изменён на на 202
POST /v2/servers/{object_id}/rescue — код успешного ответа изменён на на 202
POST /v2/servers/{object_id}/reboot — код успешного ответа изменён на на 202
POST /v2/servers/{object_id}/resize — код успешного ответа изменён на на 202
POST /v2/servers/{object_id}/password — код успешного ответа изменён на на 202

Устранены проблемы при заказе лицензий Windows и ISPmanager через Public API.

Раздел «Облачные базы данных»

POST /v2/dbaas/clusters/{object_id}/resize/storage — эндпоинт был приведён в соответствие с документацией, изменён URL и структура запроса
POST /v2/dbaas/clusters/{object_id}/resize/resources — эндпоинт был приведён в соответствие с документацией, изменён URL и структура запроса
POST /v2/dbaas/clusters/{object_id}/backup/enable — эндпоинт был приведён в соответствие с документацией, код успешного ответа изменён на на 200
POST /v2/dbaas/clusters/{object_id}/backup/disable — эндпоинт был приведён в соответствие с документацией, код успешного ответа изменён на на 200
POST /v2/dbaas/clusters/{object_id}/backup/create — эндпоинт был приведён в соответствие с документацией, изменён URL
POST /v2/dbaas/databases/{object_id}/restore — эндпоинт был приведён в соответствие с документацией, изменён URL и код ответа на 201
POST /v2/dbaas/databases/{object_id}/backup/enable — эндпоинт был приведён в соответствие с документацией, код успешного ответа изменён на на 200
POST /v2/dbaas/databases/{object_id}/backup/disable — эндпоинт был приведён в соответствие с документацией, код успешного ответа изменён на на 200
POST /v2/dbaas/databases/{object_id}/backup/create — эндпоинт был приведён в соответствие с документацией, изменён URL
GET /v2/projects/{object_id}/dbaas/backups — добавлен параметр datastore.id, присвоен код 200
GET /v2/dbaas/backups/{object_id} — присвоен код ответа 200

Раздел «Диски»

GET /v2/projects/{object_id}/volumes — добавлен параметр undetachable, добавлены поля, в которых содержатся сведения о лицензии, при ее наличии на сетевом диске
GET /v2/volumes/{object_id}/detail — добавлен параметр undetachable, добавлены поля, в которых содержатся сведения о лицензии, при ее наличии на сетевом диске
POST /v2/projects/{object_id}/volumes — код успешного ответа изменён на 201
POST /v2/volumes/{object_id}/detach — код успешного ответа изменён на 202
POST /v2/volumes/{object_id}/attach — код успешного ответа изменён на 202
POST /v2/volumes/{object_id}/extend — код успешного ответа изменён на 202

Раздел «Внешние IP-адреса»

POST /v2/projects/{object_id}/addresses — код успешного ответа изменён на 201
GET /v2/projects/{object_id}/addresses — код успешного ответа изменён на 200
POST /v2/addresses/{object_id}/attach — код успешного ответа изменён на 202
POST /v2/addresses/{object_id}/detach — код успешного ответа изменён на 202
POST /v2/addresses/{object_id}/primary — код успешного ответа изменён на 202
PUT /v2/addresses/{object_id}/ptr (put) —  код успешного ответа изменён на 202
POST /v2/addresses/{object_id}/bandwidth — код успешного ответа изменён на 202

Раздел «Снапшоты»

POST /v2/snapshots/{object_id}/restore — код успешного ответа изменён на 202
POST /v2/servers/{object_id}/snapshot — код успешного ответа изменён на 202

Раздел «SSH-ключи»

POST /v2/projects/{object_id}/keypairs — код успешного ответа изменён на 201
GET /v2/keypairs/{object_id}/detail — эндпоинт приведён к прежнему виду
DELETE /v2/keypairs/{object_id} — код успешного ответа изменён на 204
POST /v2/projects/{object_id}/keypairs/generate — код успешного ответа изменён на 201

Раздел «Лицензии»

POST /v2/servers/{object_id}/licenses — код успешного ответа изменён на 201, восстановлены поля запроса эндпоинта
PATCH /v2/licenses/{object_id} — код успешного ответа изменён на 202

Раздел «Объектное хранилище S3»

POST /v2/s3/users/{object_id}/credentials — код успешного ответа изменён на 201
POST /v2/projects/{object_id}/s3/users — код успешного ответа изменён на 201
GET /v2/s3/users/{object_id}/detail — параметр buckets_max переименован на max_buckets в соответствии с документацией
POST /v2/s3/users/{object_id}/suspend — код успешного ответа изменён на 202
POST /v2/s3/users/{object_id}/unsuspend —  код успешного ответа изменён на 202
PUT /v2/s3/users/{object_id}/quotas — код успешного ответа изменён на 202

Раздел «Балансировщики нагрузки»

GET /v2/loadbalancers/{object_id}/detail — эндпоинт был приведён в соответствие с  документацией, изменён URL
PATCH /v2/loadbalancers/{object_id} — код успешного ответа изменён на 202, параметр запроса переименован из new_name в name
POST /v2/loadbalancers/{object_id}/algorithm — код успешного ответа изменён на 202
PUT /v2/loadbalancers/{object_id}/healthmonitor — код успешного ответа изменён на 202
POST /v2/loadbalancers/{object_id}/stop — код успешного ответа изменён на 202
POST /v2/loadbalancers/{object_id}/start — код успешного ответа изменён на 202

Раздел «Виртуальные роутеры»

POST /v2/projects/{object_id}/vrouters — код успешного ответа изменён на 201
POST /v2/vrouters/{object_id}/stop — код успешного ответа изменён на 202
POST /v2/vrouters/{object_id}/start — код успешного ответа изменён на 202
GET /v2/vrouters/{object_id} — ответ на запрос восстановлен в соответствии с документацией
DELETE /v2/vrouters/{object_id} — код успешного ответа изменён на 204