- URL:https://<notebookserveradmin>/system/containers/<containerId>/sessions
- Required Capability:Administrator or Create and Edit ArcGIS Notebooks
- Related Resources:System, Containers, Container, Container Statistics, Terminate Container
- Version Introduced:10.7
Description
When an ArcGIS Notebook is opened in a container, a computational engine called a kernel is launched; the kernel runs while the notebook is active and executes all the work done by the notebook. This resource tracks the active kernels running in the specified container to provide information about current notebook sessions.
Request parameters
Parameter | Details |
---|---|
f | The response format. The default response format is html. Values: html | json | pjson |
Response properties
Property | Details |
---|---|
ID | The unique ID string for the container session. |
path | The working path to the running ArcGIS Notebook, ending in .ipynb. |
kernel | Properties describing the kernel. They are as follows:
|
JSON Response syntax
{
"sessions": [
{
"path": "<notebook path>",
"kernel": {
"last_activity": "<timestamp of most recent action>",
"name": "python3",
"id": "<kernel ID>",
"execution_state": "<status>",
"connections": <integer>
},
"name": "",
"id": "<session ID>",
"type": "notebook"
}
]
}
JSON Response example
{
"sessions": [
{
"path": "4ea4aae5d60247cb8af7146b0f7f64e4.ipynb",
"kernel": {
"last_activity": "2019-01-01T00:00:00.705020Z",
"name": "python3",
"id": "12464d15-b579-4495-865f-31aae936bef8",
"execution_state": "idle",
"connections": 0
},
"name": "",
"id": "7b3c6009-b226-47b5-bff4-3c8fd3472d44",
"type": "notebook"
}
]
}