Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
© 2022 ООО «Яндекс.Облако»
Yandex DataSphere
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Управление проектом
      • Создание проекта
      • Выбор версии Python
      • Установка зависимостей
      • Управление вычислительными ресурсами
      • Настроить ограничения вычислений для проекта
      • Настроить ограничения вычислений для каталога
      • Изменение размера хранилища проекта
      • Изменение имени или описания
      • Удаление ноутбука или проекта
    • Поделиться ноутбуком
      • Публикация ноутбука
      • Экспорт проекта
    • Работа с ноутбуком
      • Запуск примеров кода в ноутбуке
      • Версионирование. Работа с контрольными точками
      • Очистка состояния интерпретатора
      • Работа с Git
    • Управление Docker‑образами
      • Docker-образ для проекта
      • Docker-образ в ячейке
    • Подключение к источникам данных
      • Подключение к базе данных ClickHouse
      • Подключение к базе данных PostgreSQL
      • Подключение к хранилищу S3
    • Настройка интеграции с Data Proc
    • Работа с приватными данными
      • Создание секрета
      • Вызов секрета
      • Изменение секрета
      • Копирование секрета
      • Удаление секрета
    • Запуск распределенного обучения
    • Развертывание эксплуатации моделей
      • Создание ноды из ячейки с кодом на Python
      • Настройка окружения ноды
      • Запросы в ноды
  • Концепции
    • Обзор
    • Проект
    • Список предустановленного ПО
    • Доступные команды
    • Служебные команды #pragma
    • Конфигурации вычислительных ресурсов
    • Интеграция с системами контроля версий и данных
    • Сохранение состояния
    • Интеграция с Data Proc
    • Фоновые операции
    • Датасеты
    • Хранение приватных данных
    • Развертывание эксплуатации моделей
    • Использование TensorBoard в DataSphere
    • Распределенное обучение
    • Управление расходами
    • Квоты и лимиты
  • Ранний доступ
    • Обзор
    • Специальные фоновые операции
  • Практические руководства
    • Все руководства
    • Знакомство с DataSphere
    • Голосовая биометрия
    • Оценка качества STT моделей
    • Разметка аудио
    • Классификация изображений на видеокадрах
  • Справочник API
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • AppTokenService
      • FolderBudgetService
      • NodeService
      • ProjectDataService
      • ProjectService
      • OperationService
    • REST (англ.)
      • Overview
      • AppToken
        • Overview
        • validate
      • FolderBudget
        • Overview
        • get
        • set
      • Node
        • Overview
        • execute
      • Project
        • Overview
        • create
        • delete
        • execute
        • get
        • getCellOutputs
        • getNotebookMetadata
        • getStateVariables
        • getUnitBalance
        • list
        • open
        • setUnitBalance
        • update
  • Управление доступом
  • Правила тарификации
  • Публичные материалы
  • Релизы
  • Вопросы и ответы
  1. Справочник API
  2. gRPC (англ.)
  3. ProjectService

ProjectService

Статья создана
Yandex.Cloud
  • Calls ProjectService
  • Create
    • CreateProjectRequest
    • Operation
    • CreateProjectMetadata
    • Project
    • Settings
    • Limits
  • Update
    • UpdateProjectRequest
    • Operation
    • UpdateProjectMetadata
    • Project
    • Settings
    • Limits
  • Delete
    • DeleteProjectRequest
    • Operation
    • DeleteProjectMetadata
  • Open
    • OpenProjectRequest
    • Operation
    • OpenProjectMetadata
    • OpenProjectResponse
  • Get
    • GetProjectRequest
    • Project
    • Settings
    • Limits
  • List
    • ListProjectsRequest
    • ListProjectsResponse
    • Project
    • Settings
    • Limits
  • GetUnitBalance
    • GetUnitBalanceRequest
    • GetUnitBalanceResponse
  • SetUnitBalance
    • SetUnitBalanceRequest
  • Execute
    • ProjectExecutionRequest
    • Operation
    • ProjectExecutionMetadata
    • ProjectExecutionResponse
  • GetCellOutputs
    • CellOutputsRequest
    • CellOutputsResponse
  • GetStateVariables
    • GetStateVariablesRequest
    • GetStateVariablesResponse
  • GetNotebookMetadata
    • GetNotebookMetadataRequest
    • GetNotebookMetadataResponse

A set of methods for managing Project resources.

Call Description
Create Creates a project in the specified folder.
Update Updates the specified project.
Delete Deletes the specified project.
Open Opens the specified project.
Get Returns the specified project.
List Lists projects for the specified folder.
GetUnitBalance Returns the unit balance of the specified project.
SetUnitBalance Sets the unit balance of the specified project.
Execute Executes code in the specified cell or notebook.
GetCellOutputs Returns outputs of the specified cell.
GetStateVariables Returns state variables of the specified notebook.
GetNotebookMetadata Returns metadata of the specified notebook.

Calls ProjectService

Create

Creates a project in the specified folder.

rpc Create (CreateProjectRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateProjectMetadata

    Operation.response:Project

CreateProjectRequest

Field Description
folder_id string
Required. ID of the folder to create a project in. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
name string
Name of the project. The maximum string length in characters is 63. Value must match the regular expression [a-z]([-a-z0-9]{0,61}[a-z0-9])?.
description string
Description of the project. The maximum string length in characters is 256.
settings Project.Settings
Settings of the project.
limits Project.Limits
Limits of the project.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<CreateProjectMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<Project>
if operation finished successfully.

CreateProjectMetadata

Field Description
project_id string
ID of the project that is being created.

Project

Field Description
id string
ID of the project.
folder_id string
ID of the folder that the project belongs to.
created_at google.protobuf.Timestamp
name string
Name of the project. 1-63 characters long.
description string
Description of the project. 0-256 characters long.
settings Settings
Settings of the project.
limits Limits
Limits of the project.

Settings

Field Description
service_account_id string
ID of the service account, on whose behalf all operations with clusters will be performed.
subnet_id string
ID of the subnet where the DataProc cluster resides. Currently only subnets created in the availability zone ru-central1-a are supported.
data_proc_cluster_id string
ID of the DataProc cluster.
commit_mode enum CommitMode
Commit mode that is assigned to the project.
  • STANDARD: Commit happens after the execution of a cell or group of cells or after completion with an error.
  • AUTO: Commit happens periodically. Also, automatic saving of state occurs when switching to another type of computing resource.
security_group_ids[] string
Network interfaces security groups.

Limits

Field Description
max_units_per_hour google.protobuf.Int64Value
The number of units that can be spent per hour.
max_units_per_execution google.protobuf.Int64Value
The number of units that can be spent on the one execution.

Update

Updates the specified project.

rpc Update (UpdateProjectRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateProjectMetadata

    Operation.response:Project

UpdateProjectRequest

Field Description
project_id string
Required. ID of the Project resource to update. To get the project ID use a ProjectService.List request. The maximum string length in characters is 200.
update_mask google.protobuf.FieldMask
Field mask that specifies which fields of the Project resource are going to be updated.
name string
Name of the project. The maximum string length in characters is 63. Value must match the regular expression [a-z]([-a-z0-9]{0,61}[a-z0-9])?.
description string
Description of the project. The maximum string length in characters is 256.
settings Project.Settings
Settings of the project.
limits Project.Limits
Limits of the project.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<UpdateProjectMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<Project>
if operation finished successfully.

UpdateProjectMetadata

Field Description
project_id string
ID of the project that is being updated.

Project

Field Description
id string
ID of the project.
folder_id string
ID of the folder that the project belongs to.
created_at google.protobuf.Timestamp
name string
Name of the project. 1-63 characters long.
description string
Description of the project. 0-256 characters long.
settings Settings
Settings of the project.
limits Limits
Limits of the project.

Settings

Field Description
service_account_id string
ID of the service account, on whose behalf all operations with clusters will be performed.
subnet_id string
ID of the subnet where the DataProc cluster resides. Currently only subnets created in the availability zone ru-central1-a are supported.
data_proc_cluster_id string
ID of the DataProc cluster.
commit_mode enum CommitMode
Commit mode that is assigned to the project.
  • STANDARD: Commit happens after the execution of a cell or group of cells or after completion with an error.
  • AUTO: Commit happens periodically. Also, automatic saving of state occurs when switching to another type of computing resource.
security_group_ids[] string
Network interfaces security groups.

Limits

Field Description
max_units_per_hour google.protobuf.Int64Value
The number of units that can be spent per hour.
max_units_per_execution google.protobuf.Int64Value
The number of units that can be spent on the one execution.

Delete

Deletes the specified project.

rpc Delete (DeleteProjectRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteProjectMetadata

    Operation.response:google.protobuf.Empty

DeleteProjectRequest

Field Description
project_id string
Required. ID of the Project resource to delete. To get the project ID use a ProjectService.List request. The maximum string length in characters is 200.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<DeleteProjectMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<google.protobuf.Empty>
if operation finished successfully.

DeleteProjectMetadata

Field Description
project_id string
ID of the project that is being deleted.

Open

Opens the specified project.

rpc Open (OpenProjectRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:OpenProjectMetadata

    Operation.response:OpenProjectResponse

OpenProjectRequest

Field Description
project_id string
Required. ID of the Project resource to open. To get the project ID use a ProjectService.List request. The maximum string length in characters is 200.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<OpenProjectMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<OpenProjectResponse>
if operation finished successfully.

OpenProjectMetadata

Field Description
project_id string
ID of the project that is being opened.

OpenProjectResponse

Field Description
project_url string
URL of the project that is being opened. Make GET request to project_url with sessionToken query parameter equals to session_token or POST request to project_url with sessionToken body parameter equals to session_token to fetch Datasphere web interface.
session_token string
Session token of the project that is being opened.

Get

Returns the specified project.

rpc Get (GetProjectRequest) returns (Project)

GetProjectRequest

Field Description
project_id string
Required. ID of the Project resource to return. To get the project ID use a ProjectService.List request. The maximum string length in characters is 200.

Project

Field Description
id string
ID of the project.
folder_id string
ID of the folder that the project belongs to.
created_at google.protobuf.Timestamp
name string
Name of the project. 1-63 characters long.
description string
Description of the project. 0-256 characters long.
settings Settings
Settings of the project.
limits Limits
Limits of the project.

Settings

Field Description
service_account_id string
ID of the service account, on whose behalf all operations with clusters will be performed.
subnet_id string
ID of the subnet where the DataProc cluster resides. Currently only subnets created in the availability zone ru-central1-a are supported.
data_proc_cluster_id string
ID of the DataProc cluster.
commit_mode enum CommitMode
Commit mode that is assigned to the project.
  • STANDARD: Commit happens after the execution of a cell or group of cells or after completion with an error.
  • AUTO: Commit happens periodically. Also, automatic saving of state occurs when switching to another type of computing resource.
security_group_ids[] string
Network interfaces security groups.

Limits

Field Description
max_units_per_hour google.protobuf.Int64Value
The number of units that can be spent per hour.
max_units_per_execution google.protobuf.Int64Value
The number of units that can be spent on the one execution.

List

Lists projects for the specified folder.

rpc List (ListProjectsRequest) returns (ListProjectsResponse)

ListProjectsRequest

Field Description
folder_id string
Required. ID of the folder to list projects in. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
page_size int64
The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListProjectsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
page_token string
Page token. To get the next page of results, set page_token to the ListProjectsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListProjectsResponse

Field Description
projects[] Project
List of Project resources.
next_page_token string
This token allows you to get the next page of results for list requests. If the number of results is larger than ListProjectsRequest.page_size, use the next_page_token as the value for the ListProjectsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Project

Field Description
id string
ID of the project.
folder_id string
ID of the folder that the project belongs to.
created_at google.protobuf.Timestamp
name string
Name of the project. 1-63 characters long.
description string
Description of the project. 0-256 characters long.
settings Settings
Settings of the project.
limits Limits
Limits of the project.

Settings

Field Description
service_account_id string
ID of the service account, on whose behalf all operations with clusters will be performed.
subnet_id string
ID of the subnet where the DataProc cluster resides. Currently only subnets created in the availability zone ru-central1-a are supported.
data_proc_cluster_id string
ID of the DataProc cluster.
commit_mode enum CommitMode
Commit mode that is assigned to the project.
  • STANDARD: Commit happens after the execution of a cell or group of cells or after completion with an error.
  • AUTO: Commit happens periodically. Also, automatic saving of state occurs when switching to another type of computing resource.
security_group_ids[] string
Network interfaces security groups.

Limits

Field Description
max_units_per_hour google.protobuf.Int64Value
The number of units that can be spent per hour.
max_units_per_execution google.protobuf.Int64Value
The number of units that can be spent on the one execution.

GetUnitBalance

Returns the unit balance of the specified project.

rpc GetUnitBalance (GetUnitBalanceRequest) returns (GetUnitBalanceResponse)

GetUnitBalanceRequest

Field Description
project_id string
Required. ID of the project to return the unit balance for. The maximum string length in characters is 200.

GetUnitBalanceResponse

Field Description
unit_balance google.protobuf.Int64Value
The number of units available to the project.

SetUnitBalance

Sets the unit balance of the specified project.

rpc SetUnitBalance (SetUnitBalanceRequest) returns (google.protobuf.Empty)

SetUnitBalanceRequest

Field Description
project_id string
Required. ID of the project to set the unit balance for. The maximum string length in characters is 200.
unit_balance google.protobuf.Int64Value
The number of units available to the project.

Execute

Executes code in the specified cell or notebook.

rpc Execute (ProjectExecutionRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:ProjectExecutionMetadata

    Operation.response:ProjectExecutionResponse

ProjectExecutionRequest

Field Description
project_id string
Required. ID of the project to execute notebook/cell in. The maximum string length in characters is 200.
target oneof: notebook_id or cell_id
  notebook_id string
ID of the notebook to execute. The maximum string length in characters is 200.
  cell_id string
ID of the cell to execute. The maximum string length in characters is 200.
input_variables google.protobuf.Struct
Values of input variables.
output_variable_names[] string
Names of output variables.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<ProjectExecutionMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<ProjectExecutionResponse>
if operation finished successfully.

ProjectExecutionMetadata

Field Description
project_id string
ID of the project in which notebook is being executed.
target oneof: notebook_id or cell_id
  notebook_id string
ID of the notebook that is being executed The maximum string length in characters is 200.
  cell_id string
ID of the cell that is being executed The maximum string length in characters is 200.

ProjectExecutionResponse

Field Description
checkpoint_id string
ID of the checkpoint resulting from the execution.
output_variables google.protobuf.Struct
Values of output variables resulting from the execution.

GetCellOutputs

Returns outputs of the specified cell.

rpc GetCellOutputs (CellOutputsRequest) returns (CellOutputsResponse)

CellOutputsRequest

Field Description
project_id string
Required. ID of the project to return cell outputs for. The maximum string length in characters is 200.
cell_id string
Required. ID of the cell to return outputs for. The maximum string length in characters is 200.
checkpoint_id string
ID of the checkpoint to return cell outputs for.
start_at google.protobuf.Timestamp
Timestamp from which to return outputs.

CellOutputsResponse

Field Description
outputs[] string
List of outputs.

GetStateVariables

Returns state variables of the specified notebook.

rpc GetStateVariables (GetStateVariablesRequest) returns (GetStateVariablesResponse)

GetStateVariablesRequest

Field Description
project_id string
Required. ID of the project, for which to return state variables. The maximum string length in characters is 200.
notebook_id string
Required. ID of the notebook, for which to return state variables. The maximum string length in characters is 200.
variable_names[] string
Names of variables to return.
checkpoint_id string
ID of the checkpoint, for which to return state variables.

GetStateVariablesResponse

Field Description
variables google.protobuf.Struct
Values of the specified variables.

GetNotebookMetadata

Returns metadata of the specified notebook.

rpc GetNotebookMetadata (GetNotebookMetadataRequest) returns (GetNotebookMetadataResponse)

GetNotebookMetadataRequest

Field Description
project_id string
Required. ID of the project, for which to return notebook metadata. The maximum string length in characters is 200.
notebook_path string
Required. Path of the notebook to get metadata.

GetNotebookMetadataResponse

Field Description
notebook_id string
ID of the specified notebook.
created_at google.protobuf.Timestamp
The time the notebook was created.
modified_at google.protobuf.Timestamp
The time the notebook was modified last time.
content_length int64
Content length of the specified notebook.
cell_ids[] string
Cell ids of the specified notebook.

Была ли статья полезна?

Language / Region
© 2022 ООО «Яндекс.Облако»
В этой статье:
  • Calls ProjectService
  • Create
  • CreateProjectRequest
  • Operation
  • CreateProjectMetadata
  • Project
  • Settings
  • Limits
  • Update
  • UpdateProjectRequest
  • Operation
  • UpdateProjectMetadata
  • Project
  • Settings
  • Limits
  • Delete
  • DeleteProjectRequest
  • Operation
  • DeleteProjectMetadata
  • Open
  • OpenProjectRequest
  • Operation
  • OpenProjectMetadata
  • OpenProjectResponse
  • Get
  • GetProjectRequest
  • Project
  • Settings
  • Limits
  • List
  • ListProjectsRequest
  • ListProjectsResponse
  • Project
  • Settings
  • Limits
  • GetUnitBalance
  • GetUnitBalanceRequest
  • GetUnitBalanceResponse
  • SetUnitBalance
  • SetUnitBalanceRequest
  • Execute
  • ProjectExecutionRequest
  • Operation
  • ProjectExecutionMetadata
  • ProjectExecutionResponse
  • GetCellOutputs
  • CellOutputsRequest
  • CellOutputsResponse
  • GetStateVariables
  • GetStateVariablesRequest
  • GetStateVariablesResponse
  • GetNotebookMetadata
  • GetNotebookMetadataRequest
  • GetNotebookMetadataResponse