Skip to content

Latest commit

 

History

History
364 lines (273 loc) · 10.8 KB

create.md

File metadata and controls

364 lines (273 loc) · 10.8 KB
editable sourcePath
false
en/_api-ref/datasphere/v2/api-ref/Project/create.md

DataSphere API v2, REST: Project.Create

Creates a project in the specified folder.

HTTP request

POST https://datasphere.{{ api-host }}/datasphere/v2/projects

Body parameters {#yandex.cloud.datasphere.v2.CreateProjectRequest}

{
  "communityId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "settings": {
    "serviceAccountId": "string",
    "subnetId": "string",
    "dataProcClusterId": "string",
    "securityGroupIds": [
      "string"
    ],
    "earlyAccess": "boolean",
    "ide": "string",
    "defaultFolderId": "string",
    "staleExecTimeoutMode": "string",
    "vmInactivityTimeout": "string",
    "defaultDedicatedSpec": "string"
  },
  "limits": {
    "maxUnitsPerHour": "string",
    "maxUnitsPerExecution": "string"
  }
}

#| ||Field | Description || || communityId | string

Required field. ID of the community to create a project in. || || name | string

Name of the project. 0-63 characters long. || || description | string

Description of the project. 0-256 characters long. || || labels | object (map<string, string>)

Labels of the project. || || settings | Settings

Settings of the project. || || limits | Limits

Limits of the project. || |#

Settings {#yandex.cloud.datasphere.v2.Project.Settings}

#| ||Field | Description || || serviceAccountId | string

ID of the service account, on whose behalf all operations with clusters will be performed. || || subnetId | string

ID of the subnet where the DataProc cluster resides. Currently only subnets created in the availability zone ru-central1-a are supported. || || dataProcClusterId | string

ID of the DataProc cluster. || || securityGroupIds[] | string

Network interfaces security groups. || || earlyAccess | boolean

Is early access preview enabled for the project. || || ide | enum (Ide)

Project IDE.

  • IDE_UNSPECIFIED
  • JUPYTER_LAB: Project running on JupyterLab IDE. || || defaultFolderId | string

Default project folder ID. || || staleExecTimeoutMode | enum (StaleExecutionTimeoutMode)

Timeout to automatically stop stale executions.

  • STALE_EXECUTION_TIMEOUT_MODE_UNSPECIFIED
  • ONE_HOUR: Setting to automatically stop stale execution after one hour with low consumption.
  • THREE_HOURS: Setting to automatically stop stale execution after three hours with low consumption.
  • NO_TIMEOUT: Setting to never automatically stop stale executions. || || vmInactivityTimeout | string (duration)

Timeout for VM deallocation. || || defaultDedicatedSpec | string

Default VM configuration for DEDICATED mode. || |#

Limits {#yandex.cloud.datasphere.v2.Project.Limits}

#| ||Field | Description || || maxUnitsPerHour | string (int64)

The number of units that can be spent per hour. || || maxUnitsPerExecution | string (int64)

The number of units that can be spent on the one execution. || |#

Response {#yandex.cloud.operation.Operation}

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 `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "createdAt": "string",
    "name": "string",
    "description": "string",
    "labels": "object",
    "createdById": "string",
    "settings": {
      "serviceAccountId": "string",
      "subnetId": "string",
      "dataProcClusterId": "string",
      "securityGroupIds": [
        "string"
      ],
      "earlyAccess": "boolean",
      "ide": "string",
      "defaultFolderId": "string",
      "staleExecTimeoutMode": "string",
      "vmInactivityTimeout": "string",
      "defaultDedicatedSpec": "string"
    },
    "limits": {
      "maxUnitsPerHour": "string",
      "maxUnitsPerExecution": "string"
    },
    "communityId": "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 | 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. || || 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 | Project

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. || |#

CreateProjectMetadata {#yandex.cloud.datasphere.v2.CreateProjectMetadata}

#| ||Field | Description || || projectId | string

ID of the project that is being created. || |#

Status {#google.rpc.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. || |#

Project {#yandex.cloud.datasphere.v2.Project}

A Project resource.

#| ||Field | Description || || id | string

ID of the project. || || createdAt | string (date-time)

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). || || name | string

Name of the project. 1-63 characters long. || || description | string

Description of the project. 0-256 characters long. || || labels | object (map<string, string>) || || createdById | string || || settings | Settings

Settings of the project. || || limits | Limits

Limits of the project. || || communityId | string

ID of the community that the project belongs to. || |#

Settings {#yandex.cloud.datasphere.v2.Project.Settings2}

#| ||Field | Description || || serviceAccountId | string

ID of the service account, on whose behalf all operations with clusters will be performed. || || subnetId | string

ID of the subnet where the DataProc cluster resides. Currently only subnets created in the availability zone ru-central1-a are supported. || || dataProcClusterId | string

ID of the DataProc cluster. || || securityGroupIds[] | string

Network interfaces security groups. || || earlyAccess | boolean

Is early access preview enabled for the project. || || ide | enum (Ide)

Project IDE.

  • IDE_UNSPECIFIED
  • JUPYTER_LAB: Project running on JupyterLab IDE. || || defaultFolderId | string

Default project folder ID. || || staleExecTimeoutMode | enum (StaleExecutionTimeoutMode)

Timeout to automatically stop stale executions.

  • STALE_EXECUTION_TIMEOUT_MODE_UNSPECIFIED
  • ONE_HOUR: Setting to automatically stop stale execution after one hour with low consumption.
  • THREE_HOURS: Setting to automatically stop stale execution after three hours with low consumption.
  • NO_TIMEOUT: Setting to never automatically stop stale executions. || || vmInactivityTimeout | string (duration)

Timeout for VM deallocation. || || defaultDedicatedSpec | string

Default VM configuration for DEDICATED mode. || |#

Limits {#yandex.cloud.datasphere.v2.Project.Limits2}

#| ||Field | Description || || maxUnitsPerHour | string (int64)

The number of units that can be spent per hour. || || maxUnitsPerExecution | string (int64)

The number of units that can be spent on the one execution. || |#