Skip To Content
ArcGIS Developer
Dashboard

Containers

Description

This resource returns containers that are deployed on the ArcGIS Notebook Server machine. An administrator can view and manage containers that are owned by all users. Those who are not administrators will only see the containers they own.

Request parameters

ParameterDetails
f

The response format. The default response format is html.

Values: html | json | pjson

Response properties

PropertyDetails
hostname

The host name of the machine running the container.

memory

The memory of the container in megabytes.

imageName

The Docker image that the container runs from the esridocker repository.

hostIp

The IP address of the host machine.

cpus

The amount of CPU shares allotted to the container.

httpPort

The port used by the container to communicate over HTTP.

containerUrl

The URL of the container.

httpsPort

The port used by the container to communicate over HTTPS.

dateCreated

When the container was created.

id

The item ID of the container in the ArcGIS Enterprise portal.

containerId

The unique ID of the container, assigned by Docker.

username

The user assigned the container. Only one user can be assigned any given container.

Example usage

The following is a sample request URL used to access the containers resource:

https://notebookserver.domain.com:11443/arcgis/admin/system/containers?f=json

JSON Response syntax

{
  "containers": [
    {
      "hostName": "<hostname>",
      "memory": <memory in mb>,
      "imageName": "<image name>",
      "hostIp": "<hostIp>",
      "cpus": <cpu share>,
      "httpPort": <http port>,
      "containerUrl": "<container Url>",
      "httpsPort": <https port>,
      "dateCreated": "<date created in UTC Epoch time>",
      "id": "<id>",
      "containerId": "<containerId>",
      "username": "<container owner username>",
      "type": "openNotebook|executeNotebook",
      "notebookRuntimeId": "<Id of the notebook runtime used by the container>",
      "notebookRuntimeVersion": "Version of the notebook runtime used by the container",
      "notebookRuntimeName": "<Name of the notebook runtime used by the container>",
      "containerHostname": "<Hostname of the container>"
    }
  ]
}

JSON Response example

{
  "containers": [
    {
      "hostName": "ip-172-31-28-8",
      "memory": 4096,
      "imageName": "f4b0def4458c1160e7f4c835bb91464c94413bcb6aaa16fb64b4e971a33656d6",
      "hostIp": "177.31.28.8",
      "cpus": 1024,
      "httpPort": 30003,
      "containerUrl": "/notebooks/5658163256174200a0d0f1c0cd8575b2",
      "httpsPort": 30003,
      "dateCreated": "1537996656387",
      "id": "5658163256174200a0d0f1c0cd8575b2",
      "containerId": "982b9ada3f69d9da142471be32c4cd4499d8d836ad15096a5ad1f8fcdccc7e5a",
      "username": "juser001"
      "type": "openNotebook",
      "notebookRuntimeVersion": "5.0",
      "notebookRuntimeName": "ArcGIS Notebook Python 3 Advanced",
      "containerHostname": "ba86bb2168a1",
      "notebookRuntimeId": "1725316f-eabf-4935-9910-103de584a0cc"
    },
    {
      "hostName": "ip-172-31-28-8",
      "memory": 4096,
      "imageName": "4e38f29a58a66f852ecf2d9484a9794e0d1ae9481120d1b390aff105d607be0b",
      "hostIp": "177.31.28.8",
      "cpus": 1024,
      "httpPort": 30002,
      "containerUrl": "/notebooks/d965902e8834490592578c7486f32003",
      "httpsPort": 30002,
      "dateCreated": "1537995361676",
      "id": "d965902e8834490592578c7486f32003",
      "containerId": "7142502fc33b24700a3585581016cc93557074e12ab48ef4c56ea181fa3c0e02",
      "username": "jdoe007"
      "type": "openNotebook",
      "notebookRuntimeVersion": "5.0",
      "notebookRuntimeName": "ArcGIS Notebook Python 3 Standard",
      "containerHostname": "8812fa6fbc51",
      "notebookRuntimeId": "9d23fa3b-33f8-46ce-9299-13a06696c95d"
    },
    {
      "hostName": "ip-172-31-28-8",
      "memory": 4,
      "imageName": "4e38f29a58a66f852ecf2d9484a9794e0d1ae9481120d1b390aff105d607be0b",
      "hostIp": "177.31.28.8",
      "cpus": 1,
      "httpPort": -1,
      "containerUrl": "",
      "type": "executeNotebook",
      "httpsPort": -1,
      "notebookRuntimeVersion": "5.0",
      "notebookRuntimeName": "ArcGIS Notebook Python 3 Standard",
      "dateCreated": 1609918442125,
      "containerHostname": "2ad4b56e465a",
      "id": "2830a70e978549f583a7ea5b43f1f87d",
      "notebookRuntimeId": "9d23fa3b-33f8-46ce-9299-13a06696c95d",
      "containerId": "d7277556e4d0edb641f14c1c5efee50ebdfedf6e4f63f11520ee4daac2bf3834",
      "username": "jdoe007"
    }
  ]
}