Перейти к содержимому

Эндпоинты и структура URL

Эндпоинт API — URL, по которому API доступен клиентским приложениям. У каждого сервиса, доступного в API MWS, есть свой уникальный эндпоинт.

Пример: https://compute.mwsapis.ru.

Актуальный список эндпойнтов API MWS: https://api.mwsapis.ru/endpoint.

В архитектуре REST каждому ресурсу также присваивается уникальный URL, содержащий категорию ресурса и его имя. Схема URL ресурса: https://<эндпоинт сервиса>/<сервис>/<версия API>/projects/<имя проекта>/<категория ресурса>/<имя ресурса>.

Пример запроса кластера:

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

Здесь clusters — категория кластеров.

Ресурс, создаваемый в рамках другого ресурса — вложенный. URL вложенного ресурса содержит категорию и имя родительского ресурса.

Пример запроса резервной копии кластера:

bash
GET https://mpostgres.mwsapis.ru/mpostgres/v1/projects/<имя проекта>/clusters/<имя кластера>/backups/<имя резервной копии>

Здесь:

  • clusters — категория родительского ресурса;
  • backups — категория вложенного ресурса.