Contact UsGet started

DataSphere API v2, REST: Project.Execute

Written by
Updated at November 26, 2024

Executes code of the specified notebook using configuration defined in the project settings. If the default project configuration is not specified, c1.4 is used.

HTTP request

POST https://datasphere.api.cloud.yandex.net/datasphere/v2/projects/{projectId}:execute

Path parameters

Field

Description

projectId

string

Required field. ID of the project to execute notebook/cell in.

Body parameters

{
  // Includes only one of the fields `notebookId`, `cellId`
  "notebookId": "string",
  "cellId": "string",
  // end of the list of possible fields
  "inputVariables": "object",
  "outputVariableNames": [
    "string"
  ],
  "spec": "string",
  "sparkConnectorId": "string"
}

Field

Description

notebookId

string

The path to the executable notebook in the project storage. The maximum string length is 200 characters.

To get the path, right-click on the notebook in JupyterLab and select Copy path.

Includes only one of the fields notebookId, cellId.

cellId

string

ID of the cell to execute.
Deprecated

Includes only one of the fields notebookId, cellId.

inputVariables

object

Values of input variables. Input variables will be available in the project as environment variables.

outputVariableNames[]

string

Names of output variables.

spec

string

Specification of the VM

sparkConnectorId

string

ID of the Spark Connector

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "projectId": "string",
    // Includes only one of the fields `notebookId`, `cellId`
    "notebookId": "string",
    "cellId": "string"
    // end of the list of possible fields
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "executionStatus": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

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

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.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, 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.

response

ProjectExecutionResponse

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, 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.

ProjectExecutionMetadata

Field

Description

projectId

string

ID of the project in which notebook is being executed.

notebookId

string

ID of the notebook that is being executed

Includes only one of the fields notebookId, cellId.

cellId

string

ID of the cell that is being executed

Includes only one of the fields notebookId, cellId.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

ProjectExecutionResponse

Field

Description

executionStatus

enum (ExecutionStatus)

Execution final status.

  • EXECUTION_STATUS_UNSPECIFIED
  • OK: Execution finished successfully.
  • ERROR: Execution ended with error.
  • ABORTED: Execution was aborted.
Previous
SetUnitBalance
Next
ListAccessBindings