- URL:
- https://notebookserver.domain.com:11443/arcgis/admin/notebooks/runtimes/<runtimeID>/update
- Methods:
POST
- Required Capability:
- Administrator
- Version Introduced:
- 10.7
Description
This operation allows you to update the properties of a notebook runtime in ArcGIS Notebook Server. These settings will be applied to every container to which the runtime is applied.
You can use this operation to update the resource limits of the runtime, such as maximum CPU and maximum memory. You can also use it to extend either of the default notebook runtimes, to make additional Python modules available to notebook authors, or as a step for ArcGIS Notebook Server to use graphics processing units (GPUs). Documentation for these workflows can be found in the Administer section of the ArcGIS Notebook Server documentation.
Request parameters
Parameter | Details |
---|---|
(Required) | The name of the runtime. |
(Required) | The version of the runtime. |
(Optional) | The type of container image. The only valid value is |
(Required) | The image ID of the corresponding Docker container image. This is created when the image is built. |
(Optional) | The string used to pull the Docker image. |
(Required) | Set this value to Expected values: |
(Required) | The maximum number of CPU cores that can be used by a container when this runtime is applied to it. |
(Required) | The maximum amount of memory that can be used by a container when this runtime is applied to it. |
(Required) | The unit for the |
(Optional) | 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 is double that of the |
(Optional) | The unit for the |
(Optional) | The amount of shared memory available for each container. |
(Optional) | The unit specified by the |
(Optional) | Only applies to GPU runtimes. |
(Optional) | The full path to a |
(Optional) | The default response format. The default response format is Values: |
(Optional) | If set to Values: |
Response properties
Property | Details |
---|---|
| Indicates success or failure of the operation. |
JSON Response syntax
{"notebookRuntime":
{
"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>'
},
"status" "success|failure"
}
JSON Response example
{"notebookRuntime":
{
"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
},
"status" "success"
}