DataSphere API v2, REST: Project.list
Lists projects for the specified community.
HTTP request
GET https://datasphere.api.cloud.yandex.net/datasphere/v2/projects
Query parameters
Parameter | Description |
---|---|
communityId | Required. ID of the community to list projects in. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. |
pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100. |
projectNamePattern | Name pattern to filter projects that are returned. Only projects with names matching the pattern will be returned. |
ownedById | User ID to filter projects that are returned. Only projects that are owned by specified user will be returned. |
Response
HTTP Code: 200 - OK
{
"projects": [
{
"id": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"createdById": "string",
"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"
},
"communityId": "string"
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
projects[] | object List of Project resources. |
projects[]. id |
string ID of the project. |
projects[]. createdAt |
string (date-time) 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). |
projects[]. name |
string Name of the project. 1-63 characters long. |
projects[]. description |
string Description of the project. 0-256 characters long. |
projects[]. labels |
object |
projects[]. createdById |
string |
projects[]. settings |
object Settings of the project. |
projects[]. settings. serviceAccountId |
string ID of the service account, on whose behalf all operations with clusters will be performed. |
projects[]. 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. |
projects[]. settings. dataProcClusterId |
string ID of the DataProc cluster. |
projects[]. settings. commitMode |
string Commit mode that is assigned to the project.
|
projects[]. settings. securityGroupIds[] |
string Network interfaces security groups. |
projects[]. settings. earlyAccess |
boolean (boolean) Is early access preview enabled for the project. |
projects[]. settings. ide |
string Project IDE.
|
projects[]. settings. defaultFolderId |
string Default project folder ID. |
projects[]. settings. staleExecTimeoutMode |
string Timeout to automatically stop stale executions.
|
projects[]. settings. ideExecutionMode |
string VM allocation mode.
|
projects[]. settings. vmInactivityTimeout |
string Timeout for VM deallocation. |
projects[]. settings. defaultDedicatedSpec |
string Default VM configuration for DEDICATED mode. |
projects[]. limits |
object Limits of the project. |
projects[]. limits. maxUnitsPerHour |
integer (int64) The number of units that can be spent per hour. |
projects[]. limits. maxUnitsPerExecution |
integer (int64) The number of units that can be spent on the one execution. |
projects[]. communityId |
string ID of the community that the project belongs to. |
nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |