- URL:https://<notebookserveradmin>/notebooks/runtimes/
- Required Capability:Administrator or Create and Edit ArcGIS Notebooks
- Related Resources:Notebooks, Restore Factory Runtimes, Validate Runtimes, Notebook Runtime
- Version Introduced:10.7
Description
This resource provides a list of the notebook runtimes that have been registered with your ArcGIS Notebook Server site.
There is one runtime included in each Docker container image, which is applied to a container at launch time. Notebook authors open ArcGIS Notebooks in their individual containers. The runtime included with the container image makes a precise collection of Python modules available to each notebook in the container.
By default, there are two runtimes for ArcGIS Notebook Server: ArcGIS Notebook Python 3 Standard and ArcGIS Notebook Python 3 Advanced. These runtimes are loaded with their corresponding container images during ArcGIS Notebook Server installation, by running the postinstallation utility.
Request parameters
| Parameter | Details |
|---|---|
| f | The response format. The default is html. Values: html | json | pjson |
JSON Response syntax
{
"runtimes": [
{
"imageId": "<runtime 1 imageId>",
"containerType": "<containerType>",
"imagePullString": "<imagePullString>",
"maxCpu": '<maxCpu cores>,
"version": "<runtime1 version>",
"maxMemory": '<maxMemory>',
"name": "<runtime 1 name>",
"maxMemoryUnit": "<memory unit>",
"maxSwapMemory": '<max Swap Memory>',
"maxSwapMemoryUnit": "maxSwapMemoryUnit",
"id": "runtime1 id",
"requiresAdvancedPrivileges": true|false,
"sharedMemorySizeUnit": "sharedMemorySizeUnit",
"sharedMemorySize": '<sharedMemorySize>'
},
{
"imageId": "<runtime2 imageId>",
"containerType": "<containerType>",
"imagePullString": "<imagePullString>",
"maxCpu": '<maxCpu cores>,
"version": "<runtime2 version>",
"maxMemory": '<maxMemory>',
"name": "<runtime2 name>",
"maxMemoryUnit": "<memory unit>",
"maxSwapMemory": '<max Swap Memory>',
"maxSwapMemoryUnit": "maxSwapMemoryUnit",
"id": "runtime1 id",
"requiresAdvancedPrivileges": true|false,
"sharedMemorySizeUnit": "sharedMemorySizeUnit",
"sharedMemorySize": '<sharedMemorySize>'
}
]
}JSON Response example
The following example demonstrates the response returned when the two default runtimes are loaded into the site:
{
"runtimes": [
{
"imageId": "21fca3b5f9e19c37f0edebb6c072986ba3b1cd6ea7542f548d007735568dedf8",
"containerType": "docker",
"imagePullString": "",
"maxCpu": 1,
"version": "10.7",
"maxMemory": 4,
"name": "ArcGIS Notebook Python 3 Standard",
"maxMemoryUnit": "g",
"maxSwapMemory": 0,
"maxSwapMemoryUnit": "g",
"id": "933623b5-c7c4-423f-a14b-dd0f21aef398",
"requiresAdvancedPrivileges": false,
"sharedMemorySizeUnit": "m",
"sharedMemorySize": 64
},
{
"imageId": "550e90be6ac0eb9a26e1a174b7b752dd3f4a7711b0c5bbafca20d6a5d5ced4ef",
"containerType": "docker",
"imagePullString": "",
"maxCpu": 2,
"version": "10.7",
"maxMemory": 6,
"name": "ArcGIS Notebook Python 3 Advanced",
"maxMemoryUnit": "g",
"maxSwapMemory": 0,
"maxSwapMemoryUnit": "g",
"id": "bc281809-dbce-47c4-a497-ba6096df4f1a",
"requiresAdvancedPrivileges": true,
"sharedMemorySizeUnit": "m",
"sharedMemorySize": 64
}
]
}