DataSphere API v2, REST: Project.create
Creates a project in the specified folder.
HTTP request
POST https://datasphere.api.cloud.yandex.net/datasphere/v2/projects
Body parameters
{
"communityId": "string",
"name": "string",
"description": "string",
"labels": "object",
"settings": {
"serviceAccountId": "string",
"subnetId": "string",
"dataProcClusterId": "string",
"commitMode": "string",
"securityGroupIds": [
"string"
],
"earlyAccess": true,
"ide": "string",
"defaultFolderId": "string",
"staleExecTimeoutMode": "string",
"ideExecutionMode": "string",
"vmInactivityTimeout": "string",
"defaultDedicatedSpec": "string"
},
"limits": {
"maxUnitsPerHour": "integer",
"maxUnitsPerExecution": "integer"
}
}
Field | Description |
---|---|
communityId | string Required. ID of the community to create a project in. The maximum string length in characters is 50. |
name | string Name of the project. 0-63 characters long. The maximum string length in characters is 63. Value must match the regular expression |
description | string Description of the project. 0-256 characters long. The maximum string length in characters is 256. |
labels | object Labels of the project. No more than 64 per resource. The string length in characters for each key must be 1-63. Each key must match the regular expression |
settings | object Settings of the project. |
settings. serviceAccountId |
string ID of the service account, on whose behalf all operations with clusters will be performed. |
settings. subnetId |
string ID of the subnet where the DataProc cluster resides. Currently only subnets created in the availability zone ru-central1-a are supported. |
settings. dataProcClusterId |
string ID of the DataProc cluster. |
settings. commitMode |
string Commit mode that is assigned to the project.
|
settings. securityGroupIds[] |
string Network interfaces security groups. |
settings. earlyAccess |
boolean (boolean) Is early access preview enabled for the project. |
settings. ide |
string Project IDE.
|
settings. defaultFolderId |
string Default project folder ID. |
settings. staleExecTimeoutMode |
string Timeout to automatically stop stale executions.
|
settings. ideExecutionMode |
string VM allocation mode.
|
settings. vmInactivityTimeout |
string Timeout for VM deallocation. |
settings. defaultDedicatedSpec |
string Default VM configuration for DEDICATED mode. |
limits | object Limits of the project. |
limits. maxUnitsPerHour |
integer (int64) The number of units that can be spent per hour. |
limits. maxUnitsPerExecution |
integer (int64) The number of units that can be spent on the one execution. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// 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 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 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 (boolean) If the value is |
metadata | object 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 | object The error result of the operation in case of failure or cancellation. includes only one of the fields error , response |
error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
error. message |
string An error message. |
error. details[] |
object A list of messages that carry the error details. |
response | object includes only one of the fields error , response 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. |