- URL:
- https://<notebookserveradmin>/notebooks/runtimes/<runtimeID>
- Methods:
GET- Operations:
- Update Notebook Runtime, Unregister Notebook Runtime
- Child Resources:
- Runtime Manifest
- Required Capability:
- Administrator or Create and Edit
- Version Introduced:
- 10.7
Description
This resource provides information about the properties of a specific notebook runtime in your ArcGIS Notebook Server site. The runtime is included in a 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.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default is Values: |
Response properties
| Parameter | Details |
|---|---|
| Unique identifier of the runtime. |
| The name of the runtime. |
| The version of the runtime. |
| The type of container image. The only valid value is docker. |
| The image ID of the corresponding Docker container image. This is created when the image is built. |
| The string used to pull the Docker image. |
| A string used to specify a Docker runtime environment. Values: |
| A Boolean indicating whether the runtime is provided by Esri. Values: |
| A Boolean indicating whether the runtime is deprecated. Values: |
| A Boolean indicating whether the runtime is disabled and not available for use. Values: |
| A Boolean indicating whether the Advanced Notebooks privilege is required to use the runtime. Values: |
| A Boolean indicating whether GPU support is enabled for this runtime. Values: |
| The maximum number of CPU cores that can be used by a container when this runtime is applied to it. |
| The maximum amount of memory that can be used by a container when this runtime is applied to it. |
| The unit for the above Values: |
| The maximum amount of total memory, including swap space, that can be used by a container when this runtime is applied to it. If left unspecified, the value will be double that of the |
| The unit for the above maxSwapMemory parameter. Values: |
| Amount of shared memory available to a container using this runtime. |
| Unit for sharedMemorySize. Values: |
JSON Response syntax
{
"imageId": "<runtime imageId>",
"containerType": "<containerType>",
"deprecated": true|false,
"imagePullString": "<imagePullString>",
"maxCpu": <maxCpu cores>,
"version": "<runtime2 version>",
"maxMemory": <maxMemory>,
"esriProvidedRuntime": true|false,
"useGPU": true|false,
"dockerRuntime": "<dockerRuntime>",
"name": "<runtime2 name>",
"maxMemoryUnit": "<maxMemoryUnit>",
"maxSwapMemory": <maxSwapMemory>,
"maxSwapMemoryUnit": "<maxSwapMemoryUnit>",
"disabled": true|false,
"id": "runtime2 id",
"requiresAdvancedPrivileges": true|false,
"sharedMemorySizeUnit": "<sharedMemorySizeUnit>",
"sharedMemorySize": <sharedMemorySize>
}JSON Response Esri-provided runtime example
{
"deprecationDate": 1969689600000, // Deprecated
"imageId": "",
"containerType": "docker",
"deprecated": false,
"imagePullString": "",
"maxCpu": 2,
"version": "14.0",
"maxMemory": 6,
"esriProvidedRuntime": true,
"useGPU": false,
"dockerRuntime": "",
"name": "ArcGIS Notebook Python 3 Standard",
"maxMemoryUnit": "g",
"maxSwapMemory": 0,
"maxSwapMemoryUnit": "g",
"disabled": false,
"id": "a57fd47a-5134-4df4-9d34-9581d8e9d11e",
"requiresAdvancedPrivileges": false,
"sharedMemorySizeUnit": "m",
"sharedMemorySize": 2048
}JSON Response custom runtime example
{
"imageId": "",
"containerType": "docker",
"deprecated": false,
"imagePullString": "",
"maxCpu": 1,
"version": "14.0",
"maxMemory": 4,
"esriProvidedRuntime": false,
"useGPU": false,
"dockerRuntime": "",
"name": "Custom Runtime",
"maxMemoryUnit": "g",
"maxSwapMemory": 0,
"maxSwapMemoryUnit": "g",
"disabled": false,
"id": "d3b54426-7360-4790-963a-dce829a94ef1",
"requiresAdvancedPrivileges": false,
"sharedMemorySizeUnit": "m",
"sharedMemorySize": 2048
}