Notebook Runtime

URL:: https://<notebookserveradmin>/notebooks/runtimes/<runtimeID>
Methods:: GET
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
`f`	The response format. The default is `html` . Values: `html` \| `json` \| `pjson`

Response properties

Parameter	Details
`name`	The name of the runtime.
`version`	The version of the runtime.
`containerType`	The type of container image. The only valid value is docker.
`imageId`	The image ID of the corresponding Docker container image. This is created when the image is built.
`imagePullString`	The string used to pull the Docker image.
`requiresAdvancedPrivileges`	A Boolean indicating whether the Advanced Notebooks privilege is required to use the runtime. Values: `true` \| `false`
`maxCpu`	The maximum number of CPU cores that can be used by a container when this runtime is applied to it.
`maxMemory`	The maximum amount of memory that can be used by a container when this runtime is applied to it.
`maxMemoryUnit`	The unit for the above `maxMemory` property. Values: `g` \| `m` \| `k` \| `b`
`maxSwapMemory`	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 `maxMemory` value.
`maxSwapMemoryUnit`	The unit for the above maxSwapMemory parameter. Values: `g` \| `m` \| `k` \| `b`
`manifestFile`	The full path to a file containing the list of Python libraries in the runtime.

JSON Response syntax

Use dark colors for code blocksCopy
{
  "imageId": "<runtime imageId>",
  "containerType": "<containerType>",
  "imagePullString": "<imagePullString>",
  "maxCpu": '<maxCpu cores>,
  "version": "<runtime version>",
  "maxMemory": '<maxMemory>',
  "name": "<runtime name>",
  "maxMemoryUnit": "<memory unit>",
  "maxSwapMemory": '<max Swap Memory>',
  "maxSwapMemoryUnit": "maxSwapMemoryUnit",
  "id": "runtime id",
  "requiresAdvancedPrivileges": true|false,
  "sharedMemorySizeUnit": "sharedMemorySizeUnit",
  "sharedMemorySize": '<sharedMemorySize>'
}

JSON Response example

Use dark colors for code blocksCopy
{
  "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
}