- tocdepth
2
Проекты
Подсказка
Актуальную спецификацию можно скачать и использовать в привычном инструменте.Перед началом работы
Для работы с API личного кабинета Cloud.ru потребуется:
эндпоинт для запросов —
https://organization.api.cloud.ru;customer_id— его можно скопировать в личном кабинете.
Набор методов для управления проектами
- GET /v1/projects
Получение списка проектов, удовлетворяющих фильтру.
- Query Parameters
status (string) –
Фильтр по статусу проекта.
PROJECT_STATUS_UNSPECIFIED: Неизвестный статус проекта.
PROJECT_STATUS_ENABLED: Проект активен.
PROJECT_STATUS_DISABLED: Проект неактивен.
page_filter.limit (integer) – Количество сущностей на странице.
page_filter.page (integer) – Номер страницы. Нумерация начинается с 1.
project_ids (array) – Фильтр по id проекта.
customer_ids (array) – Фильтр по id клиента.
organization_unit_ids (array) – Фильтр по id каталога.
- Status Codes
200 OK – A successful response.
400 Bad Request – Некорректный запрос
401 Unauthorized – Необходима авторизация
403 Forbidden – Доступ запрещен
404 Not Found – Ресурс не найден
500 Internal Server Error – Внутренняя ошибка сервера
- Response JSON Object
projects (array) – Список проектов.
projects[].created_at (string) – Дата создания проекта.
projects[].customer_id (string) – Идентификатор клиента.
projects[].description (string) – Описание проекта.
projects[].id (string) – Идентификатор проекта.
projects[].name (string) – Название проекта.
projects[].organization_unit_id (string) – Идентификатор каталога.
projects[].status (string) – Статус проекта.
projects[].updated_at (string) – Дата обновления проекта.
- POST /v1/projects
Создание проекта.
- Request JSON Object
description (string) – Описание проекта.
name (string) – Название проекта.
organization_unit_id (string) – Идентификатор каталога.
- Status Codes
200 OK – A successful response.
400 Bad Request – Некорректный запрос
401 Unauthorized – Необходима авторизация
403 Forbidden – Доступ запрещен
404 Not Found – Ресурс не найден
500 Internal Server Error – Внутренняя ошибка сервера
- Response JSON Object
created_at (string) – Дата создания проекта.
customer_id (string) – Идентификатор клиента.
description (string) – Описание проекта.
id (string) – Идентификатор проекта.
name (string) – Название проекта.
organization_unit_id (string) – Идентификатор каталога.
status (string) – Статус проекта.
updated_at (string) – Дата обновления проекта.
- GET /v1/projects/{id}
Получение проекта по id.
- Parameters
id (string) – Идентификатор проекта.
- Status Codes
200 OK – A successful response.
400 Bad Request – Некорректный запрос
401 Unauthorized – Необходима авторизация
403 Forbidden – Доступ запрещен
404 Not Found – Ресурс не найден
500 Internal Server Error – Внутренняя ошибка сервера
- Response JSON Object
created_at (string) – Дата создания проекта.
customer_id (string) – Идентификатор клиента.
description (string) – Описание проекта.
id (string) – Идентификатор проекта.
name (string) – Название проекта.
organization_unit_id (string) – Идентификатор каталога.
status (string) – Статус проекта.
updated_at (string) – Дата обновления проекта.
- DELETE /v1/projects/{id}
Удаление проекта по id.
- Parameters
id (string) – Идентификатор проекта.
- Status Codes
200 OK – A successful response.
400 Bad Request – Некорректный запрос
401 Unauthorized – Необходима авторизация
403 Forbidden – Доступ запрещен
404 Not Found – Ресурс не найден
500 Internal Server Error – Внутренняя ошибка сервера
- PATCH /v1/projects/{id}
Обновление проекта по id.
- Parameters
id (string) – Идентификатор проекта.
- Request JSON Object
description (string) – Описание проекта.
name (string) – Название проекта.
- Status Codes
200 OK – A successful response.
400 Bad Request – Некорректный запрос
401 Unauthorized – Необходима авторизация
403 Forbidden – Доступ запрещен
404 Not Found – Ресурс не найден
500 Internal Server Error – Внутренняя ошибка сервера
- Response JSON Object
created_at (string) – Дата создания проекта.
customer_id (string) – Идентификатор клиента.
description (string) – Описание проекта.
id (string) – Идентификатор проекта.
name (string) – Название проекта.
organization_unit_id (string) – Идентификатор каталога.
status (string) – Статус проекта.
updated_at (string) – Дата обновления проекта.
для Dev & Test