Методы и применение операций

Для управления ресурсами по их URL-адресам используются стандартные и дополнительные методы.

API MWS позволяет выполнять как CRUD-операции: создание, получение, изменение, удаление, так и дополнительные операции, например, остановка или запуск кластера. Стандартные методы API для CRUD-операций имеют одинаковую сигнатуру. Сигнатура дополнительных методов отличается от сигнатуры стандартных.

Пример сигнатуры стандартного метода с GET-запросом для получения параметров кластера:

1
GET https://mpostgres.mwsapis.ru/mpostgres/v1/projects/<имя проекта>/clusters/<имя кластера>

Пример сигнатуры дополнительного метода с действием :stop для остановки кластера:

1
POST https://mpostgres.mwsapis.ru/mpostgres/v1/projects/<имя проекта>/clusters/<имя кластера>:stop

Операции, изменяющие состояние ресурса (создание, обновление, удаление, запуск, остановка), возвращают ответ немедленно, но изменение может вступить в силу не мгновенно. Ответ содержит полную информацию о ресурсе, включая его идентификатор, статус и состояние готовности. Чтобы отслеживать статус ресурса, используйте GET-запрос. Например, при создании кластера в ответе будет статус CREATING. Когда кластер будет готов, статус изменится на RUNNING.

Если при выполнении операции возникла ошибка, сервер вернет соответствующий HTTP-код и сообщение с причиной. При этом ресурс не будет создан или останется в предыдущем состоянии.