Обзор API
В DataSphere все основные операции по работе с ресурсами и ноутбуками доступны не только из пользовательского интерфейса, но и через API.
Для управления ресурсами в API Yandex Cloud определен набор методов gRPC и REST. Особенности их реализации и взаимодействия см. в Документации API Yandex Cloud.
Работа с проектом
Методы ProjectService позволяют создать, открыть, обновить и удалить проект. Также вы можете просмотреть список проектов в конкретном каталоге.
| Метод | Описание |
|---|---|
| Create | Создает новый проект в указанном каталоге. |
| Update | Обновляет проект. |
| Delete | Удаляет проект. |
| Open | Открывает проект. |
| Get | Возвращает информацию о проекте. |
| List | Возвращает список проектов в указанном каталоге. |
Пример. Создание нового проекта:
grpcurl -rpc-header "Authorization: Bearer <IAM-токен>" \
-d '{"folder_id": "<folder_id>"}' \
datasphere.api.cloud.yandex.net:443 \
yandex.cloud.datasphere.v1.ProjectService/Create
Пример. Вывод списка проектов в каталоге:
grpcurl -rpc-header "Authorization: Bearer <IAM-токен>" \
-d '{"folder_id": "<folder_id>"}' \
datasphere.api.cloud.yandex.net:443 \
yandex.cloud.datasphere.v1.ProjectService/List
Подробную информацию о методах ProjectService см. в API-документации.
Работа с данными проекта
Методы ProjectDataService позволяют загружать файлы из проекта и в проект.
| Метод | Описание |
|---|---|
| UploadFile | Загружает файл в указанный проект. |
| DownloadFile | Загружает файл из указанный проекта. |
Пример. Загрузка файла из проекта:
grpcurl -rpc-header "Authorization: Bearer <IAM-токен>" \
-d '{"project_id": "<project_id>", "file_path": "<file_path>"}' \
datasphere.api.cloud.yandex.net:443 \
yandex.cloud.datasphere.v1.ProjectDataService/DownloadFile
Подробную информацию о методах ProjectDataService см. в API-документации.
Работа с ноутбуком
Методы ProjectService позволяют запустить ноутбук или конкретную ячейку, получить результаты выполнения определённой ячейки, получить значения переменных состояния ноутбука или метаданные.
| Метод | Описание |
|---|---|
| Execute | Запускает заданную ячейку или ноутбук. |
| GetCellOutputs | Возвращает результаты выполнения ячейки. |
| GetStateVariables | Возвращает значение переменных состояния ноутбука. |
| GetNotebookMetadata | Возвращает информацию о метаданных ноутбука. |
Пример. Запуск конкретной ячейки ноутбука:
grpcurl -rpc-header "Authorization: Bearer <IAM-токен>" \
-d '{"project_id": "<project_id>", "target": "cell_id", "cell_id": "<cell_id>"}' \
datasphere.api.cloud.yandex.net:443 \
yandex.cloud.datasphere.v1.ProjectService/Execute
Пример. Вывод результатов выполнения конкретной ячейки ноутбука:
grpcurl -rpc-header "Authorization: Bearer <IAM-токен>" \
-d '{"project_id": "<project_id>", "cell_id": "<cell_id>"}' \
datasphere.api.cloud.yandex.net:443 \
yandex.cloud.datasphere.v1.ProjectService/GetCellOutputs
Подробную информацию о методах ProjectService см. в API-документации.
Управление ограничениями вычислений
С помощью API-методов вы можете настраивать ограничения вычислений для проекта (ProjectService) или каталога (FolderBudgetService).
| Метод | Описание |
|---|---|
| GetUnitBalance | Возвращает баланс проекта. |
| SetUnitBalance | Устанавливает баланс проекта. |
| Get | Возвращает баланс каталога. |
| Set | Устанавливает баланс каталога. |
Пример. Получение баланса проекта:
grpcurl -rpc-header "Authorization: Bearer <IAM-токен>" \
-d '{"project_id": "<project_id>"}' \
datasphere.api.cloud.yandex.net:443 \
yandex.cloud.datasphere.v1.ProjectService/GetUnitBalance
Пример. Получение баланса каталога:
grpcurl -rpc-header "Authorization: Bearer <IAM-токен>" \
-d '{"folder_id": "<folder_id>"}' \
datasphere.api.cloud.yandex.net:443 \
yandex.cloud.datasphere.v1.FolderBudgetService/Get
Больше примеров см. в пошаговых инструкциях:
Подробную информацию о методах см. в API-документации ProjectService и FolderBudgetService.
Кроме перечисленных методов, вы сможете воспользоваться другими сервисными методами для работы с операциями, нодами и управлением токенами: